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

add openapi or swagger #4

Open
TuxCoder opened this issue Jun 21, 2020 · 3 comments
Open

add openapi or swagger #4

TuxCoder opened this issue Jun 21, 2020 · 3 comments

Comments

@TuxCoder
Copy link

It would be nice for understanding if there is a swagger or openapi file that describe the api.
Also it can help for implement and testing components.

https://openapi-generator.tech/
https://swagger.io/
https://www.openapis.org/

@TuxCoder
Copy link
Author

Sorry already exists partially, would like to have a yaml or json file, but I think that can generated from this code.

Good Work!

@TuxCoder
Copy link
Author

for who is interessted here the raw file
https://gist.github.com/TuxCoder/1fa962b97357beb3b1918172cf045a65

can be used in any openapi 2.0 viewer like https://editor.swagger.io/

@TuxCoder TuxCoder reopened this Jun 26, 2020
@TuxCoder
Copy link
Author

reopen, because documentation is to less, when I see what is really send.

here[1] the api is clear defined, this does not exist on the server, also invalid data in the database can cause false send data, eg. crash of client or other undefined behavior.

[1]https://github.com/austrianredcross/stopp-corona-android/blob/develop/app/src/main/java/at/roteskreuz/stopcorona/model/entities/configuration/ApiConfiguration.kt

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

No branches or pull requests

1 participant