Skip to content

Latest commit

 

History

History
181 lines (153 loc) · 5.56 KB

README.md

File metadata and controls

181 lines (153 loc) · 5.56 KB
Raw

OpenAPI UI

OpenAPI/Swagger UI document, quickly generate mock params and call api, also simplified postman tool

License Release (latest by date) npm openapi-ui package build framework

English | 简体中文

Screen Shot

postman

Website domain

Usage

With CDN

spec-url is full path

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>openAPI UI</title>
  </head>
  <body>
    <div id="openapi-ui-container" spec-url="https://petstore3.swagger.io/api/v3/openapi.json" theme="light"></div>
    <script src="https://cdn.jsdelivr.net/npm/openapi-ui-dist@latest/lib/openapi-ui.umd.js"></script>
  </body>
</html>

spec-url is path

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>openAPI UI</title>
  </head>
  <body>
    <div id="openapi-ui-container" spec-url="/openapi.json" theme="dark"></div>
    <script src="https://cdn.jsdelivr.net/npm/openapi-ui-dist@latest/lib/openapi-ui.umd.js"></script>
  </body>
</html>

With React(or With Vue)

import { useEffect } from "react";

const SetUpOpenApiUI = () => {
  useEffect(() => {
    import("openapi-ui-dist")
  }, []);

  return (
    <div id="openapi-ui-container" spec-url="https://petstore3.swagger.io/api/v3/openapi.json" theme="light" />
  );
}

export const openapiRoutes = {
  path: "/openapi",
  id: "openapi",
  element: <SetUpOpenApiUI />,
};

With Go Web Framework

With Nodejs Web Framework

Quick start

# node version >= 18
# download node_modules
pnpm install
# or make install

# start
npm run dev
# or make dev

Some script

# build
npm run build
# or make build

# make docker image
make docker-build

# run docker image
make docker-run

# make docker image and run docker image
make docker-build-run

Support data format

  • swagger2.json/swagger2.yml
  • openapi3.json/openapi3.yml

How to use

  • enter swagger2/openapi3 api gateway URL, refresh the page to update the interface
  • upload swagger2/openapi3 file
  • enter swagger2/openapi3 text

Global config

  • supports configure request timeout, the default request timeout is 2 minutes
  • supports configure request Authorization, Authorization can be overridden in the current request

Share URL

  • url can only be shared when imported through url mode
  • copy the url and share it with those who need it, they can echo the url to the specified interface

Mock request params

  1. if the schema contains the format field, then use openapi-sampler to mock request params
  2. if the schema does not contain the format field, then use faker to mock request params

Request error message display rules

  1. if the returned structure contains a message field, display the message field
  2. if the returned structure contains a msg field, display the msg field
  3. if the returned result is a string, display the string
  4. display AxiosResponse.statusText field
  5. display AxiosError.message field

Connect intranet api

  • if unable to connect intranet api, you can run this project locally or use docker to deploy this project locally or on the server

Support multiple api gateway URL

  • the caching strategy used is session storage, so you can open multiple pages at the same time

Docker deploy, support env variable injection

# pull Docker image
docker pull ghcr.io/rookie-luochao/openapi-ui:latest

# start container, nginx reverse proxy custom port, for example: docker run -d -p 8081:80 ghcr.io/rookie-luochao/openapi-ui:latest
docker run -d -p 80:80 -e APP_CONFIG=env=zh,appNameZH=简洁美观的接口文档 ghcr.io/rookie-luochao/openapi-ui:latest

Node version

node >= 18