Implement Swagger for API

V-Sekai / uro

Provides functionality needed to run your V-Sekai backend. It will serve custom game content, support content caching, and provide a user authentication system

https://v-sekai.org

MIT License

8 stars 3 forks source link

Implement Swagger for API #4

Open SaracenOne opened 3 years ago

SaracenOne commented 3 years ago

Configure Swagger so that the API can be outputted into a JSON file for automating the creation of API libraries.

benbot commented 2 years ago

I think i'll try tackling this next

I just found https://github.com/xerions/phoenix_swagger

benbot commented 2 years ago

So i started working on this, realized that phoenix_swagger was already in the project AND realized that it still requires you to write documentation manually.

I did that for a little bit then got bored, so i don't think im going to do this next :sweat_smile:

but i did find https://github.com/api-hogs/bureaucrat which would auto generate docs for us based on our tests (which we still need to make at some point) so maybe that would be more fun to work on.