https://github.com/mrin9/openapi-viewer

OpenApi viewer Implemented using Vue
https://github.com/mrin9/openapi-viewer

api api-client mrindoc openapi openapi-ui swagger swagger-ui

Last synced: 12 days ago
JSON representation

OpenApi viewer Implemented using Vue

• Host: GitHub
• URL: https://github.com/mrin9/openapi-viewer
• Owner: mrin9
• Created: 2018-12-01T05:06:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-11T17:04:57.000Z (over 2 years ago)
• Last Synced: 2024-10-23T08:52:31.308Z (21 days ago)
• Topics: api, api-client, mrindoc, openapi, openapi-ui, swagger, swagger-ui
• Language: Vue
• Homepage: https://mrin9.github.io/OpenAPI-Viewer/
• Size: 11.5 MB
• Stars: 104
• Watchers: 2
• Forks: 21
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# MrinDoc

An OpenAPI 3.0 and 2.0 Spec viewer with built in console 

### [Demo](https://mrin9.github.io/OpenAPI-Viewer)

### Checkout RapiDoc - Another project for Viewing OpenAPI spec using web-Componnet

#### [Checkout RapiDoc](https://mrin9.github.io/RapiDoc)

# Features

- Supports Swagger V2.0 and OpenAPI 3.0

- Supports searching of end-points (paths)

- Built In console to try out APIs

- Responsive (support for desktop and tablets)

- Supports Authentication

  - OAuth2

  - API Key(Token)

  - HTTP Bearer

  - HTTP Basic

- UX friendly.

  - All Endpoints paths are cleanly presented

  - Clear seperation of Request and Response info laid out side by side in a two colum layout

  - Lesser clicks to deal with. All schema models, response-jsons and examples are expanded by defaults which eliminates the need of click and reveal each level.

  - While using API console, request data is pre-filled based on schema

  - Needs just one click to try out live APIs

## Project Build

```

yarn install

yarn run build 

```

### Screenshots

#### EndPoint Listings



    



#### Request/Response

Laid out in a two colum for easy view & compare 



    



#### Schema View

All Request/Response schema and Response JSONs are expanded by default, so that you dont have to click and reveal each level for easy browsing and read



    



#### Console

Built in console, fields are pre-filled with values if exist in spec, request body is generated and filled based on schema, allowing you to quickly try out the end-point with a single click 



    



#### Authentication Support

All the authentication methods are supported. Along with instructions on how to use it