Coder Social home page Coder Social logo

arkii / openapi-viewer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mrin9/openapi-viewer

0.0 0.0 0.0 11.75 MB

OpenApi viewer Implemented using Vue

Home Page: https://mrin9.github.io/OpenAPI-Viewer/

JavaScript 29.30% HTML 2.01% Vue 53.83% CSS 14.62% Shell 0.23%

openapi-viewer's Introduction

MrinDoc logo

MrinDoc

An OpenAPI 3.0 and 2.0 Spec viewer with built in console

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

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

openapi-viewer's People

Contributors

mrin9 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.