Skip to content

Commit

Permalink
Swagger docs for the REST API (#141)
Browse files Browse the repository at this point in the history
* Add (incomplete) swagger docs for the REST API

* Add information about execution result

* Minor tweaks

* Remove unused type

* Group models

* List required fields

* Vanilla code generation

* Add the config which generates default models (documenting behavior)

* Move swagger file closer to the source of all truth

* Add a makefile

* Split server, client and models

* Explicit type names (no anonymous structs)

* Changing the approach again because of some codegen corner cases

* Pretty well rounded scheme

* Update code references

* Remove petstore URL

* Switch to using new server code
  • Loading branch information
Maelkum authored Apr 26, 2024
1 parent 4731e9a commit 7902bc3
Show file tree
Hide file tree
Showing 17 changed files with 1,628 additions and 100 deletions.
14 changes: 14 additions & 0 deletions api/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


all: server client models


server:
oapi-codegen --config ./server.yaml ./b7s-swagger.yaml

client:
oapi-codegen --config ./client.yaml ./b7s-swagger.yaml

models:
oapi-codegen --config ./models.yaml ./b7s-swagger.yaml

Loading

0 comments on commit 7902bc3

Please sign in to comment.