Giter Site home page Giter Site logo

rusagaib / oas-preview.nvim Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.25 MB

WIP a simple nvim/neovim plugin to preview oas/openapi3 or swagger spec.

License: MIT License

Lua 100.00%
api-documentation-tool hacktoberfest lua neovim openapi openapi3 plugin swagger swagger-ui

oas-preview.nvim's Introduction

image

oas-preview.nvim

WIP a simple nvim plugin to privew oas/openapis3 or swagger spec currently serve the api-docs using swagger-ui only..

image

Installations ๐Ÿš€

1. Installing the UI :

Swagger-ui (docker)

  1. Pull swagger-ui from docker hub:
~$ docker pull swaggerapi/swagger-ui:latest

2. Install Plugin

Packer:

add this line on your packer config.lua just add rusagaib/oas-preview.nvim

use {'rusagaib/oas-preview.nvim'}

3. Apply oas-preview plugin :

In your init.lua (Default):

require("oas-preview")

4. Run :

:OASPreview

it will call another buffer split to bottom, press enter and then it will build container to run swagger-ui to serve api documentation based from swagger or openapi3 spec (.yaml or .json)

5. Stop opts:

:OASPreviewStop

Any contributions are welcome ๐Ÿบ

oas-preview.nvim's People

Watchers

 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.