API Documentation

[navinpai]

Document the SlashGo Server API in either README or in a more in-depth format like OpenAPI to allow easy reference to API methods, fields and possible edge cases.

[zahertalab]

Is it a RESTful API? If yes, where I can start?

[navinpai]

Hey @zahertalab ,

Yes, it is a restful API. The API routes are all part of the api directory and they call code in the controllers directory which can be used as a reference for validations etc.

[zahertalab]

I wonder if there is some swagger or open API UI available?

[navinpai]

We don't have Swagger/OpenAPI set up as of today, but if you can set up a swagger yaml, I'd be happy to have it part of the project to make it more accessible to folks in the future! 👍

Update: @zahertalab We now have a new swagger documentation repo: https://github.com/Slash-Go/Docs ... I've moved the issue to the new repo. Docs are currently served at https://docs.slashgo.link/ from this repo.

[EleekaN]

Hi @navinpai I want to work on this. Just to summarize, you want the swagger documentation to be updated with other end points like Auth , Organizations etc.

[navinpai]

Hi @navinpai I want to work on this. Just to summarize, you want the swagger documentation to be updated with other end points like Auth , Organizations etc.

Yes, that's right... It would be great to have the swagger.yaml updated with all the endpoints and responses

Thanks in advance!

[EleekaN]

Sure...is there one location/file where I can get all the endpoints and responses. I remember seeing some of it on different folders.

…

On Mon, 31 Oct, 2022, 15:06 Navin Pai, ***@***.***> wrote: Hi @navinpai <https://github.com/navinpai> I want to work on this. Just to summarize, you want the swagger documentation to be updated with other end points like Auth , Organizations etc. Yes, that's right... It would be great to have the swagger.yaml <https://github.com/Slash-Go/Docs/blob/main/swagger.yaml> updated with all the endpoints and responses Thanks in advance! — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKIWLY2JKVNL7BXSECB2IGLWF6HJNANCNFSM6AAAAAAREQXQKU> . You are receiving this because you commented.Message ID: ***@***.***>

[navinpai]

Sure...is there one location/file where I can get all the endpoints and responses. I remember seeing some of it on different folders.

The API routes are all part of the api directory and they call code in the controllers directory which can be used as a reference for validations etc. Sorry we don't have a single path for it yet, but we're hoping this repo becomes that single source of truth for the API 😸

[EleekaN]

localhost://3000 doesn't reflect the changes I make on the swagger.yaml file. How can I sync it locally, so I can validate my work?

[navinpai]

Once you make changes in swagger file, please do the following steps from the README to update the generated index.html file with your changes:

// If you don't have redoc-cli, install it
$ npm i -g redoc-cli serve

$ redoc-cli build swagger.yaml -o index.html
$ serve -s .

[EleekaN]

Hi @navinpai, I have done some baseline work for 'auth' endpoints. Need some inputs and feedback before I proceed further . I will create a pull request, please have a look.