API仕様を書く（まとめ）: 柴田 芳樹 (Yoshiki Shibata)
「API仕様を書く」として私自身の過去の経験を書いたものを読みやすく並べてみました。 API仕様を書く（1） API仕様を書く（2） API仕様を書く（3） API仕様を書く（4） API仕様を書く（5）ー gRPC protoファイル ー API仕様を書く（6）ー gRPC protoファイル（2） ー API仕様を書く（7） ちょうど同じような内容が『A Philosophy of Software Design』に書かれていました。 関連する章は、第12章「Why Write Comments? The Four Execuses」と第15章「Write The Comments First」です。第12章では、コメントを書かない理由として多くのソフトウェアエンジニアが挙げる理由について反証しています。第15章ではコメントを最初に書くことの有用性を説いています。ここでのコメントは、私
[golang]goaを使ってAPIの設計・開発し、OpenAPIドキュメントを自動生成する
golangでAPIサーバーを開発したい！でも、何からやっていいかわからない。そんなときにはgoaがオススメだ。 goaの特徴 goaの最大の特徴はAPIデザインを書くとモック、クライアントツール、ドキュメントなどを自動生成できるところだ。 開発は以下のような手順になる。 DSLでAPIデザインを書く goagen(コードジェネレーター)で自動生成する クライアントのスケルトン テストコード CLIツール OpenAPI仕様のドキュメント APIを実装する ビルドして実行する このように人の手が入るのは「1.DLSでAPIデザインを書く」と「3.APIを実装する」だけだ。それ以外はgoagenというコードジェネレーターが自動的にやってくれる。 golang初心者の私でも、はじめて触ってから3時間くらいで動くAPIサーバーをつくることができた。 以下にgoaを使ってAPIサーバーを開発する手
![[golang]goaを使ってAPIの設計・開発し、OpenAPIドキュメントを自動生成する](https://cdn-ak-scissors.b.st-hatena.com/image/square/f5c7b6800c729ee4777652188d78eed629f82528/height=288;version=1;width=512/https%3A%2F%2Fblogger.googleusercontent.com%2Fimg%2Fb%2FR29vZ2xl%2FAVvXsEiiFlrdPvBm2XpPu4XWA73p7NBck916Hm8DYxupg_xB4YX4L7KjoRoSVMr083B-Zjnlu9thNjFqk-xjSSeQKaGotokYK0TdE19Mc7ND0_rWghgfJCcDLGlRFBxDKJ_oWnWjFcdIQvJxCBff%2Fw1200-h630-p-k-no-nu%2Fgoa-design.png)
- The RESTful cookbook
Welcome to the REST CookBook REST is hot! And REST is finally rediscovered by API programmers all over the world. But REST isn't always as easy as it seems on first look. Dealing with HATEOAS, Code on demand and uniform interfaces can be really tricky and many people will fall back to not-so-restful approaches when things are starting to become more difficult. But it doesn't need to be. Once you g
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
社内システムの構造と設計、実装のはなし
