README.md

GeekMagic OpenApi

Unofficial GeekMagic OpenApi document written in TypeSpec. Researched on Geekmagic-smalltv but it should be works for other devices.

How to use

Build result

• OpenAPI document
  • For use with client generators
• API reference web page (by redocly)
  • For read the api specs

How to build

In case you want to build yourself, please follow below things.

Requirements

• Node.js > 20
• pnpm

Commands

pnpm install
pnpm run build:tsp
pnpm run build:docs

License

MIT

Maintainer

Dosugamea

Related references

• TypeSpec が OpenAPI や JSON Schema を書くのに良かったので紹介する
  • https://zenn.dev/kimuson/articles/typespec_openapi
• OpenAPIドキュメントを書いて作って公開する
  • https://zenn.dev/robon/articles/c72deed4632b9d
• TypeScript のような構文で OpenAPI のスキーマを定義する TypeSpec
  • https://azukiazusa.dev/blog/typescript-like-syntax-for-openapi-schemas/