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

Integrated Docs Page? #1

Open
fortytw2 opened this issue Mar 2, 2024 · 1 comment
Open

Integrated Docs Page? #1

fortytw2 opened this issue Mar 2, 2024 · 1 comment

Comments

@fortytw2
Copy link

fortytw2 commented Mar 2, 2024

Found this project via your reddit comment - was wondering if you were planning on tucking in a handler that end-users can use to self-host a docs site easily

Something like https://github.com/stoplightio/elements?tab=readme-ov-file#web-component would work pretty easily slammed into an HTML output. I'd be happy to contribute the code for this later if you're interested

@matt1484
Copy link
Owner

matt1484 commented Mar 2, 2024

I think a ResponseWriter that more gracefully handles html/templates would be nice. Currently you could use api.Static(apiPath, filesPath string) to mount a static directory or use the built-in OpenAPI docs served via SwaggerUI at /docs (which is available on every api object

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

2 participants