April 2022
Beginner to intermediate
464 pages
6h 44m
Japanese
Content preview from 実用 Go言語 ―システム開発の現場で知っておきたいアドバイス
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
10.7 APIドキュメントを生成する
フロントエンド・バックエンドの両方を小さいチームで開発する場合は、APIドキュメントを準備せず「仕様はコードを見て欲しい」といったやり取りで成立する場面も多いでしょう。しかし、ある一定規模ではスケーラビリティの観点からAPI仕様書のようなリファレンスドキュメントを求められる場合が増えてきます。HTTP APIの場合はOpenAPI Specification（以後OAS）を利用すると簡単にリファレンスドキュメントを生成できて便利です。OASはYAML（JSON）でAPI情報を定義していきますが、開発が進むとともにAPI定義も進化することが多く、API定義とGoのサーバー実装との間で、同期をどう取るかの戦略が重要です。現実的にはAPI定義を正にするか、Goのコードを正にするかの2択となるでしょう。運用形態によって3つに分類します。
Goのコードを元に、OASファイルを生成する（コードファースト）。
swaggo/swagなどのツールが有名自動生成は行わず、OASファイルとGoコードをダブルメンテする。またはOASファイルを提供しない。生成ツールによる制約を受けないことがメリット
OASファイルから作成する（スキーマ駆動）。StoplightのようなGUIエディタツールが存在します。OASファイルからGoのコード生成することが多い。
deepmap/oapi-codegenなどのツールが有名
最近はフロントエンドでもOASファイルからコードを自動生成したり、別のマイクロサービスからAPI呼び出しされる要件なども増えてきていることから、③のスキーマ駆動を選択するケースが増えてきていると感じます。 deepmap/oapi-codegen ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.