search

hotfix-studios / scrum-poker

This is an application that integrates with GitHub Projects for seamless import of product backlogs into a UI for easy sprint estimation.
MIT License
2 stars 0 forks source link

docs-implement-swagger-open-api #31

Open colinwilliams91 opened 7 months ago

colinwilliams91 commented 7 months ago

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

OR

more redoc docs and redoc configuration reference

References

Redoc

Image

Swagger

Image

colinwilliams91 commented 7 months ago

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