Hako CMS
ログイン無料で始める

機能 ／ 配る

型と OpenAPI

スペースのスキーマから、TypeScript の型、OpenAPI 3.1 の定義、GraphQL のスキーマを書き出せます。

型のダウンロードの欄。TypeScript の型、OpenAPI（JSON）、GraphQL（SDL）のリンクが並んでいる

こんなときに

  • サイトのコードでフィールドの名前を間違えたら、組む前に気づきたいとき
  • TypeScript 以外の言語でも、OpenAPI からクライアントを作りたいとき
  • スキーマを変えたら、CI で型を作り直したいとき

開発者から見ると

OpenAPI の定義は API でも取れます。どの権限の API キーでも構いません。

端末
curl -fsS https://<ホスト名>.hakocms.net/api/v1/schema/openapi.json \
  -H "Authorization: Bearer <API キー>" \
  -o hakocms-openapi.json
hakocms-cli schema types --space blog > src/hakocms-types.ts

GraphQL はイントロスペクションにも答えるので、GraphQL Code Generator などをそのままつなげられます。

細かい仕様

書き出せるものTypeScript の型、OpenAPI 3.1（JSON）、GraphQL のスキーマ（SDL）
取り方管理画面の［API キー］の画面、API（/api/v1/schema/…）、hakocms-cli
型の名前コンテンツタイプ ID を PascalCase にしたもの（blog-posts は BlogPosts）
変え方の約束/api/v1 の中では項目を足すだけで、消したり型を変えたりしません
使えるプランすべてのプラン

詳しくはドキュメントの「Content API のリファレンス」に書いています。

無料で始める

フリーのプランで、すべての機能を試せます。カードは要りません。