docs-implement-swagger-open-api

[colinwilliams91]

Describe the Problem

Front End and Back End teams are siloed and have HTTP requests going back and forth over dynamic and evolving routes.

Manually documenting this is difficult.

Describe the Proposed Solution

Implementing

• swagger
  • 78k downloads/week npm
  • npm i swagger-ui
  • repository - swagger-ui

OR

• redoc
  • 311k downloads/week npm
  • npm i redoc
  • supports JSON & C#
  • npm + readme

more redoc docs
and redoc configuration reference

References

Redoc

Swagger

[colinwilliams91]

Here's a sample redocly.yaml configuration file, showing a few common settings and tweaking some of the visual theme settings:

theme:
  openapi:
    disableSearch: true
    expandResponses: 200,202
    jsonSampleExpandLevel: 1

    theme:
      sidebar:
        backgroundColor: '#eae0cc'
        textColor: '#3d005b'
      colors:
        primary:
          main: '#660099'
      typography:
        fontSize: 14pt
        headings:
          fontWeight: bold