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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@himenon/openapi-typescript-practice

v0.1.2

Published

OpenAPIを利用したAPI作成と、開発、リリースフローまでの仕組みづくりの練習

Downloads

11

Readme

TypeScript のプロジェクトで OpenAPI を利用するための手法の整理

| Registry | Status | | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | | npm | npm version |

Development

package.json scripts

{
  "build": "build code and generate docs",
  "cherry-pick": "Create Proxy Directories",
  "clean": "clean up",
  "copy:lib": "copy files to release directory",
  "mock:server": "yarn run mock:server endpoints/Article/index.yml",
  "tsc:build:cjs": "Generate Commonjs",
  "tsc:build:esm": "Generate ES module",
  "tsc:build:types": "Generate Type definition only",
  "release:github:registry": "publish github for registry",
  "release:npm:registry": "publish for npm registry"
}

Release

release version

yarn run lerna version --yes

Tools

Preview

Realtime

  • https://marketplace.visualstudio.com/items?itemName=philosowaffle.openapi-designer

Docker

yarn run swagger:server
  • https://hub.docker.com/r/swaggerapi/swagger-ui/

API Mock Server (PORT 4000)

yarn run prism:server
  • https://www.npmjs.com/package/@stoplight/prism-cli
  • https://github.com/stoplightio/prism

Static Document Generator

  • https://github.com/Redocly/redoc
  • https://www.npmjs.com/package/redoc-cli

Linter

  • https://marketplace.visualstudio.com/items?itemName=mermade.openapi-lint

Formatter

Development Flow

  • src/の yml を編集時、OpenApi Preview で確認
  • API MockServer を起動して、API の疎通確認

Build Flow

  • openapi-generator-cliを利用して、dist/以下にコードを自動生成

Trouble Shooting

openapi-generator

Cannot find name 'GlobalFetch'.

--additional-properties=typescriptThreePlus=true
  • https://github.com/OpenAPITools/openapi-generator/issues/3869#issuecomment-584152932

Reference

WARN i.s.v.p.p.ExternalRefProcessor - A model for class Schema

  • ディレクトリ名に予約語を利用している場合に発生する
    • created
    • updated
    • deleted
    • entity
    • model

[main] WARN o.o.c.ignore.CodegenIgnoreProcessor - Output directory does not exist, or is inaccessible. No file (.openapi-generator-ignore) will be evaluated.

対応中

LICENSE

MIT