项目作者: koumoul-dev

项目描述 :
OpenAPI viewer component for VueJS
高级语言: Vue
项目地址: git://github.com/koumoul-dev/vue-openapi.git
创建时间: 2016-11-30T23:56:46Z
项目社区:https://github.com/koumoul-dev/vue-openapi

开源协议:MIT License

下载


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 :

  1. $ npm install --save vue-openapi

Usage

  1. import Vue from 'vue'
  2. import VueMaterial from 'vue-material'
  3. import OpenApi from 'vue-openapi'
  4. import 'vue-material/dist/vue-material.css'
  5. import VueResource from 'vue-resource'
  6. import jsonApi from './swagger.json'
  7. Vue.use(VueMaterial)
  8. Vue.use(VueResource)
  9. new Vue({
  10. el: '#app',
  11. template: '<open-api v-if="jsonApi" :api="jsonApi" md-theme="\'default\'" :query-params="queryParams" :headers="headers"></open-api>',
  12. data: () => ({
  13. jsonApi: jsonApi,
  14. queryParams: {
  15. userId: 'john_doe'
  16. },
  17. headers: {
  18. api_key: 'my_api_key'
  19. }
  20. }),
  21. components: {
  22. OpenApi
  23. }
  24. })

Develop

Run webpack in watch mode:

  1. 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 :