npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

openapi-ui-dist

v2.3.3

Published

<h1 align="center"> OpenAPI UI </h1> <p align="center"> OpenAPI/Swagger UI document, quickly generate mock params and call api, also simplified postman tool </p> <p align="center"> <a href="https://github.com/rookie-luochao/openapi-ui/blob/master/LICE

Downloads

62

Readme

Screen Shot

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