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 link to distrochooser API documentation #249

Open
ghost opened this issue Mar 5, 2023 · 1 comment
Open

add link to distrochooser API documentation #249

ghost opened this issue Mar 5, 2023 · 1 comment

Comments

@ghost
Copy link

ghost commented Mar 5, 2023

Is your feature request related to a problem? Please describe.
api-distrochooser is already written in swagger, but there is no custom link about the api documentation in swagger. I can't find the link about the technical documentation about the api. For example, something like: https://docs.distrochooser.de/api-version/1/stats/

Describe the solution you'd like
I wish there was online documentation on swagger for the distrochooser api. For example, something like: https://docs.distrochooser.de/api-version/1/stats/

Describe alternatives you've considered

  • We can have a custom link like: https://petstore.swagger.io/
  • Is there any public api so that I can consult other information through an http call through the rest architecture? Something like repository: public-apis/public-apis has? Example:
    • Query with the get method all the statistics of distrochooser stats: https://api.distrochooser.de/api-version/1/stats/getAll
    • Query with the get method all the distros of distrochooser: https://api.distrochooser.de/api-version/1/distros/getAll
      or https://docs.distrochooser.de/api-version/1/ ?

Additional context

  • "Swagger allows you to describe the structure of your APIs so that machines can read them. The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great?"
  • "Well, by reading your API’s structure, we can automatically build beautiful and interactive API documentation."
  • "We can also automatically generate client libraries for your API in many languages and explore other possibilities like automated testing."
  • "Swagger does this by asking your API to return a YAML or JSON that contains a detailed description of your entire API."
@ghost ghost changed the title distrochooser with docs to api add link to distrochooser API documentation Mar 5, 2023
@cmllr
Copy link
Member

cmllr commented Mar 26, 2023

Thank you for the suggestion!

the swagger usage in Distrochooser needs an rework. I will add it to my to do list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant