推奨されるAPI構築手順について

Question

今までAPIの利用がほとんどなかったのですが、
会社としてAPI利用を推奨しようとしています。

そこで、API開発手順を検討していますが、
Swagger定義を先に書いて、コードのモックを自動生成する場合と、
コードがからSwagger定義を起こす場合、
どちらが推奨されるといったことはあるでしょうか？

すでに運用されている方た"ちがどのような手順で行っているかわからないため、
推奨や経験論教えて頂けますと幸甚です。

Comments

[Q71]

ちょっと意味がわからない。Application Program Interface を使わずに、今までどうやって、何を作っていたのでしょうか。API というか、会社としてのライブラリを作る、ということですか？

Answer 1

「 APIの利用がない」というとユーザー目線の話かと思いきや、API開発の話でしょうか？

ユーザーとしてSwaggerは使ったことはありますが、開発での経験はないので一般論ですが…。
コード自動生成の類のものは、完全な新規作成であれば省力化のため使いたい、という事はあると思います。

ただ、SwaggerのようにSpec書けばドキュメント起こしてくれる類のものは、ツールの利用に慣れていないなら先にコード書いた方が良いんじゃないですかね。

Swagger使うこと自体はAPI開発の主たる目的じゃないわけで、学習コストが自分の予想以上に高かったり、最悪スケジュールに悪影響を与えそうなら、そこは切り捨てちゃってもAPIの開発自体はできるわけですから。

Comments

[aoiro27]

ありがとうございます。
おっしゃる通り、swagger記法の習得コストが掛かるし、
記法間違いなどによる対応時間も懸念されるため、
バックエンドのAPIから起こした方が良さそうですね。
その方向で検討してみます。