Skip to content

Repository files navigation

Open API Toolkit

Alternative to swagger UI client written in Vue JS.

  • It has fullscreen mode for request and for response (F11/Esc)
  • Can handle basic auth
  • Can change servers on the go when they are setup in schema
  • Filtering for paths with regexp or simple search

Dependencies

  • it uses bootstrap4
  • it uses open icon

Version

NPM

StateVersionBranch
master^0.0.3master

Downloading

  • npm install @apitte/openapi-toolkit

Development

  • npm install
  • npm run start
  • open localhost:8080 in your browser

Deployment

  • npm run build

Usage

Using compiled in your html

<!doctype html><htmllang="en"><head><metacharset="UTF-8"><metaname="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"><metahttp-equiv="X-UA-Compatible" content="ie=edge"><title>OpenApi Toolkit</title><!--LOAD BOOTSTRAP--><scriptsrc="https://code.jquery.com/jquery-3.2.1.slim.min.js"
integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN"
crossorigin="anonymous"></script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js"
integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q"
crossorigin="anonymous"></script><linkrel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css"
integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous"><scriptsrc="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"
integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl"
crossorigin="anonymous"></script><!--LOAD OPEN ICONS--><linkrel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/open-iconic/1.1.1/font/css/open-iconic-bootstrap.min.css"
integrity="sha256-BJ/G+e+y7bQdrYkS2RBTyNfBHpA9IuGaPmf9htub5MQ=" crossorigin="anonymous"/></head><body><divid="opentoolkit"></div><scriptsrc="<path to your dist>/dist/vendor.js"></script><scriptsrc="<path to your dist>/dist/main.js"></script><script>//Initialize open toolkit to idvarmySwaggerJson={};//here you load your swaggeropenToolkitInit("#opentoolkit",mySwaggerJson);</script></body></html>

Single page application

importVuefrom"vue";importOpenApiClientfrom"@apitte/openapi-toolkit";importSWAGGERfrom"./swagger.json";newVue({el: "#app",render: h=>h(OpenApiClient,{props: {schema: SWAGGER}})});

In vue component

<template>
<div>
<open-api-client:schema="schema"/>
</div>
</template>
<script>importOpenApiClientfrom"@apitte/openapi-toolkit";importSWAGGERfrom"./swagger.json";exportdefault {	components: {OpenApiClient},data() {return { schema:TEST_SWAGGER };	}};</script>

Maintainers

Jura Papp


The development is sponsored by Tlapnet

About

♦️ Simple and intuitive OpenApi/Swagger compatible UI toolkit

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages