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.

Sign up for GitHub

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

Jump to bottom

Generate API Documentation #7

Open
amiller-gh opened this issue Jan 5, 2020 · 2 comments
Open

Generate API Documentation #7

amiller-gh opened this issue Jan 5, 2020 · 2 comments

Comments

@amiller-gh
Copy link
Owner

It should be possible to generate an API overview page and endpoint explorer! There are many ways to approach this and needs to be designed out.
@myoungerman
Copy link

@amiller-gh Do you have endpoints that you want documented? I'm new to writing API documentation, but I know how to document endpoints!

@amiller-gh
Copy link
Owner Author

I'm more thinking that Loll, as part of discovering API endpoints on disk at startup, can also auto-generate a documentation page for each user drafted endpoint and serves it up. Would love to use an existing API docs generator that can leverage something like JSDoc, typescript types, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amiller-gh @myoungerman