A simpler and more beautiful openapi document than swagger-ui, quickly generate mock params and call api request

• CN: www.openapi-ui.com
• US: doc.openapi-ui.com
• US2: docs.openapi-ui.com

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

// start
npm run dev
# or make dev

// 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

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

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

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

• 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

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

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

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

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

# 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 >= 18