https://github.com/prosapient/prosapient-swagger-ui

Alternative Slate-like OpenAPI visual documentation
https://github.com/prosapient/prosapient-swagger-ui

Last synced: 9 months ago
JSON representation

Alternative Slate-like OpenAPI visual documentation

• Host: GitHub
• URL: https://github.com/prosapient/prosapient-swagger-ui
• Owner: prosapient
• Created: 2021-05-04T13:37:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T13:55:36.000Z (over 4 years ago)
• Last Synced: 2025-01-07T18:26:06.220Z (10 months ago)
• Language: TypeScript
• Size: 1.94 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# proSapient Swagger / OpenAPI viewer

This is Slate-like alternative to SwaggerUI based on proSapient styleguide.

![proSapient Swagger](/screenshots/image.png?raw=true "proSapient Swagger")

## Advantages

* Bare CRA app with minimum ad-hoc changes

* 100% Compatible with OpenAPI v3.0

* 3-columns Slate-like view

* Advanced markdown render

## Setup

* Setup `REACT_APP_SPEC_URL` with url to open-api spec

* Since render is dynamic make sure that open-api host is CORS friendly

* Run `yarn start` to run the app

* Use any react-app hosting (e.g. netlify) for docs hosting.

## Notes

* OpenAPI v3.0 supports markdown in `description` fields (not only). 

* All code snippets will be moved to right column in documentation.

* This render splits main `description` field into sections based on headers (#) and sub-headers (##).

* all description supports markdown tables.

* Code snippet may use title:

```ruby

  ```ruby Title here

  code here

```