Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Documentation + Kotlin DSL #249

Merged
merged 1 commit into from
Nov 14, 2021
Merged

Conversation

Syer10
Copy link
Collaborator

@Syer10 Syer10 commented Nov 12, 2021

This continues #248 using a custom DSL that will help us write the endpoint documentation.

I tested the DSL on the manga retrieve endpoint and it works perfectly. I did not add any of the updates endpoint documentation, that can be done at a later time.

Description of previous PR:
Added https://javalin.io/plugins/openapi to Tachidesk.
There are now two new paths available:

/api/openapi.json - OpenApi Document in JSON Representation
/api/swagger-ui - Swagger Frontend to view API Documentation and use the API

OpenApi isn't able to document WebSockets as of now.
I fully documented the UpdateController using the dsl API. Which provides flexibility in the placement of the documentation.

@ntbm ntbm mentioned this pull request Nov 12, 2021
@AriaMoradi AriaMoradi merged commit b02884f into Suwayomi:master Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants