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

typescript-koa: support serving docs using redoc #81

Open
mnahkies opened this issue Sep 24, 2023 · 0 comments
Open

typescript-koa: support serving docs using redoc #81

mnahkies opened this issue Sep 24, 2023 · 0 comments
Labels
good first issue Good for newcomers typescript-koa

Comments

@mnahkies
Copy link
Owner

add support for optionally serving documentation generated using https://github.com/Redocly/redoc for servers using typescript-koa template

essentially this will involve:

  • exposing a route /docs returning an html document including the redoc html below
  • exposing a route /openapi.yaml returning the specification used to generate the server

the html will look similar to:

<html>
<body>
    <redoc spec-url="http://petstore.swagger.io/v2/swagger.json"></redoc>
    <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
</body>
</html>

with the spec path updated, and a sub resource integrity hash added (https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity)

this functionality should be optional, and the routes configurable to ensure that it can be used without collision with the actual API surface.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers typescript-koa
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mnahkies