OpenAPI + Redoc, Docusaurus, Mermaidで始めるスキーマ・ドキュメント駆動開発
無料で読める本
【この本について】 この本はOpenAPIを使ってドキュメントを作成する方法を学びます。 OpenAPIを使ってドキュメントを作成することで継続的な開発を行うことができ、 OpenAPI Generatorを使ってドキュメントと実装のズレをなくすことができます。 また、Docusaurusを使ってドキュメントを作成することで、 運用ドキュメントを簡単に公開することができます。 本書では以下の内容を取り扱っています。 - Docusarusでドキュメント環境を構築する - OpenAPI + Redocでドキュメントを作成する - OpenAPI Generatorで自動生成する - Prismでモックサーバーを導入する OpenAPIを使ってみたい人、社内の設計・運用ドキュメントの管理に困っている人が対象です。 【更新情報】 2023/08/01: v1.0.0を公開しました。 【感想・誤字報告】 感想・誤字報告は下記の scrap に投稿をお願いします。 https://zenn.dev/gangannikki/scraps/23b777186ddd04
Chapters
はじめに
Docusaurus + Redoc + Mermaid環境を構築する
OpenAPI(Swagger)環境を構築する
OpenAPI Generator環境を構築する
Prism を用いて Mock API を立ててみる
Community
Author
Topics