-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
Description
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
/docsreturning an html document including the redoc html below - exposing a route
/openapi.yamlreturning 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.