serv/mox
1
0
Fork 0
mirror of https://github.com/mjl-/mox.git synced 2024-12-26 16:33:47 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
mox/vendor/github.com/mjl-/sherpats
History
Mechiel Lukkien 0c800f3d7e
update to latest sherpats fixing typo in error message, handle absent dmarc "policy override" reason
2024-03-09 15:43:49 +01:00
..
cmd/sherpats add webmail 2023-08-07 21:57:03 +02:00
LICENSE add webmail 2023-08-07 21:57:03 +02:00
Makefile add webmail 2023-08-07 21:57:03 +02:00
README.md add webmail 2023-08-07 21:57:03 +02:00
sherpats.go replace http basic auth for web interfaces with session cookie & csrf-based auth 2024-01-05 10:48:42 +01:00
ts.go update to latest sherpats fixing typo in error message, handle absent dmarc "policy override" reason 2024-03-09 15:43:49 +01:00

README.md

Sherpats

Sherpats reads the (machine-readable) documentation for a sherpa API as generated by sherpadoc, and outputs a documented typescript module with all functions and types from the sherpa documentation. Example:

sherpadoc MyAPI >myapi.json
sherpats < myapi.json >myapi.ts

Read the sherpats documentation.

Tips

At the beginning of each call of an API function, the generated typescript code reads a localStorage variable "sherpats-debug". You can use this to simulate network delay and inject failures into your calls. Example:

localStorage.setItem('sherpats-debug', JSON.stringify({waitMinMsec: 0, waitMaxMsec: 1000, failRate: 0.1}))

Info

Written by Mechiel Lukkien, mechiel@ueber.net, MIT-licensed, feedback welcome.

Todo

  • linewrap long comments for fields in generated types.
  • check if identifiers (type names, function names) are keywords in typescript. if so, rename them so they are not, and don't clash with existing names.
  • better error types? how is this normally done in typescript? error classes?
  • add an example of a generated api
  • write tests, both for go and for the generated typescript