unkeyed / unkey

Open source API management platform
https://go.unkey.com
Other
4k stars 469 forks source link

Swagger ui for open API routes #618

Closed G3root closed 10 months ago

G3root commented 10 months ago

Preliminary Checks

Is your feature request related to a problem? Please describe.

Currently there isn't any documentation for the backend routes. integration swagger can help document and test the backend API using a Ui

Describe the solution

We can use @hono/swagger-ui to generate one

Describe alternatives you have considered (if any)

No response

Additional context

No response

G3root commented 10 months ago

I'm willing to open a Pr if approved

perkinsjr commented 10 months ago

Hey there thanks for reaching out. The API for Unkey is documented.

https://unkey.dev/docs/api-reference/authentication

It uses OpenAPI to power the endpoints and documents them and can test the API using a UI if you so wish.

How does SwaggerUI benefit us here versus what we already have in our documentation?

perkinsjr commented 10 months ago

Closing the issue as we already are using our openAPI to document backend routes with the ability to test it in browser