airy icon indicating copy to clipboard operation
airy copied to clipboard

Research swagger for API and client generation

Open chrismatix opened this issue 4 years ago • 1 comments

Current state Airy Core has ~41 API routes that are accessible to clients. Each of them requires payload definitions for clients and standard markdown documentation.

We have a typescript and a go client that each implement a subset of those APIs and maintain their own payloads

Research objective Figure out if we can use Swagger or similar open-source tools to automatically solve these two problems:

  • Generating client code
  • Generating documentation

Things to look out for:

  • Reference implementations
  • Compatability with Spring
  • Can the generated doc output be integrated into Markdown?
  • How is the generated client code consumed?
  • Does the generated client code live up to language developer expectations? I.e. does the typescript code look like Java code?
  • Can it be used with Bazel? (trick question. Everything can be used with Bazel)

chrismatix avatar Feb 02 '21 15:02 chrismatix

https://redocly.github.io/redoc/ interesting! Especially in combination with https://github.com/rohit-gohri/redocusaurus

lucapette avatar Mar 10 '21 11:03 lucapette