README.md

Tanomimaster REST API 仕様書

• OAS（OpenAPI Specification）3.0で構築

ワークフロー

• OpenAPIを設計し、サーバーサイドでプログラムを作成する

• 開発の中心はdevelopブランチ

• @matsuboがtanomimaster-wwwをデプロイする際にdevelopブランチをレビューし、developをmasterにマージする。APIバージョン番号をインクリメントする

• master

  • クライアントとベンダーに公開
  • 現在の本番リリース

• develop

  • 最新の開発バージョン

サーバーサイドとクライアントサイドのアプリケーションデプロイメントを関連付けるブランチリリースモデルを再定義する必要があります。

ポリシー

• Richardson成熟度モデル
  • レベル2が必要
• GitLabのAPI設計に従う
  • https://docs.gitlab.com/ee/api/README.html#gitlab-ci-job-token

GitHub Actionsをローカルで実行

% act pull_request

ローカルでOASのvalidation

何も出力されなければOKです。

% bundle exec ruby test.rb

ツール

• エディター
  • まだ推奨エディターはありません
• ビューアー
  • OpenAPI（Swagger）エディター
    • Visual Studio Code拡張機能
    • https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
  • Swagger Editor
    • https://editor.swagger.io/
  • Stoplight Studio
    • https://stoplight.io/p/studio/
    • ダウンロード版アプリの方がWeb版より優れています
    • 予期しない動作が多く、予期しない値でYAMLファイルを変更します