Skip to content

Commit

Permalink
Updated documentation about client code generation
Browse files Browse the repository at this point in the history
  • Loading branch information
giordy committed Dec 1, 2021
1 parent 23de253 commit 486b123
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,13 @@ npm run serve -- --watch
Now open http://localhost:8080/. You should see the generated API doc.

Make modifications to `doc/specs/lichess-api.yaml`, and reload the page to see your changes.

## Auto-generate client code

You may use the spec file to quickly auto-generate the client code needed to interface your software to the Lichess API.

To do so, you shall use the [OpenAPI Generator](https://openapi-generator.tech).

The generator does not yet support the 3.1 version of the OpenAPI specification ([see this issue](https://github.com/OpenAPITools/openapi-generator/issues/9083)), the one used by Lichess, hence for now you should use the `doc/specs/lichess-api-3.0.yaml` file with it.

The 3.1 format slightly differs from the 3.0 format, however the generated code is equivalent.

0 comments on commit 486b123

Please sign in to comment.