@koumoul/vue-openapi

    0.12.3 • Public • Published

    OpenAPI viewer component for VueJS

    This Vue.js component is designed to easily browse and test a REST API described with the OpenAPI 3.0 Specification (formerly known as Swagger Specification). This component follows Google Material Design principles and relies on the Vue Material framework. It also relies on vue-resource to perform API requests.

    See it in action :

    Install

    npm :

    $ npm install --save vue-openapi

    yarn:

    $ yarn add vue-openapi

    Usage

    import Vue from 'vue'
    import VueMaterial from 'vue-material'
    import OpenApi from 'vue-openapi'
    import 'vue-material/dist/vue-material.css'
    import VueResource from 'vue-resource'
     
    import jsonApi from './swagger.json'
     
    Vue.use(VueMaterial)
    Vue.use(VueResource)
     
    new Vue({
      el: '#app',
      template: '<open-api v-if="jsonApi" :api="jsonApi" md-theme="\'default\'" :query-params="queryParams" :headers="headers"></open-api>',
      data: () => ({
        jsonApi: jsonApi,
        queryParams: {
          userId: 'john_doe'
        },
        headers: {
          api_key: 'my_api_key'
        }
      }),
      components: {
        OpenApi
      }
    })

    Develop

    Run webpack in watch mode:

    npm run dev
    

    Then open test/index.html in your browser.

    To switch between examples, modify the import "jsonApi" in test/app.js.

    License

    MIT License

    Resources

    Similar projects

    This project has been inspired by the following projects :

    Install

    npm i @koumoul/vue-openapi

    DownloadsWeekly Downloads

    18

    Version

    0.12.3

    License

    MIT

    Unpacked Size

    38.6 kB

    Total Files

    13

    Last publish

    Collaborators

    • bonnel-n
    • albanm