mnahkies/openapi-code-generator

typescript-koa: support serving docs using redoc

Open

#81 opened on Sep 24, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (9 forks)auto 404
good first issuetypescript-koa

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

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 /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.

Contributor guide

Research direction
Examine the existing typescript koa template to understand how routes are defined and registered, then add optional routes for /docs and /openapi.yaml returning the redoc HTML and the spec file respectively, making them configurable.
Tech stack
typescriptnodejs
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60