tsoaはいいぞ！APIドキュメントを自動生成！

tsoaはいいぞ！   APIドキュメントを   自動生成！         三海
純(ミカイジュン) 

ミカイジュン (三海純)   • 株式会社ゆめみ   •
趣味: もくもく会、アニメ、ラブカ(ラブライブTCG)   • 好きな有名人   ◦ 後藤ひとり   ◦ 陸八魔アル   ◦ 千早愛音  ◦ 八木唯 

キャリア   • 2020年 ~ 2022年: 受託企業   ◦ フロントエンドエンジニア
  • 2022年 ~ 2023年: 自社開発企業   ◦ フロントエンド&バックエンドエンジニア   • 2024年: フリーランス   ◦ Typescriptでリプレース(技術選定)&開発   • 2025年2月   ◦ 株式会社ゆめみ正社員  

こんなことありませんか？   スキーマ(Open API仕様書) と  実際のレスポンス違うぞ・・・  

そして・・・   YAMLファイルを   書いて1日が終わる日々・・・  

そんなあなたにおすすめしたいのが   tsoa  引用元: https://tsoa-community.github.io/docs/  

tsoaとは？   tsoa は、TypeScript を使用して Node.js サーバー側アプリケーションを構築するための OpenAPI コンパイラを統合したフレームワークです。  
実行時に Express 、hapi、koa などのフレームワークをターゲットにすることができます。 tsoa アプリケーションはデフォルトでタイプセーフであり、実行時の検証をシームレスに処理します。   英文引用元: https://tsoa-community.github.io/docs/introduction.html  

ようするに・・・   ExpressなどのNode.jsフレームワークでコードを書くと   スキーマを自動生成してくれる!  

@Route("users") export class UsersController extends Controller { @Get("{userId}") public async
getUser( @Path() userId: number, @Query() name?: string ): Promise<User> { return new UsersService().get(userId, name); } @SuccessResponse("201", "Created") @Post() public async createUser( @Body() requestBody: UserCreationParams ): Promise<void> { this.setStatus(201); new UsersService().create(requestBody); return; } }

スキーマ自動生成！   引用元: https://tsoa-community.github.io/docs/live-reloading.html  

http://localhost:3000/docs で動作確認できる！   引用元: https://tsoa-community.github.io/docs/live-reloading.html  

スキーマが自動生成されることで・・・   フロントエンド側でバックエンドの   スケジュールに関係なく   APIを叩けるようになった！  

なぜって・・・？  

フロントエンドエンジニアがtsoaでバックエンド実装   すればいいじゃない！   (DB通さないで適当なレスポンスを返すのもあり)  

おそらく・・・   フロントエンド側も   TypeScript使ってることが多いと思うので   tsoaを使うことで   バックエンド実装がしやすくなる  

tsoaがもっと流行ると・・・   フロントエンドエンジニア   バックエンドエンジニア   というポジションが融合されるかも？  

まとめ  スキーマを書く手間を   省きたいならtsoaはいいぞ！  

ご清聴ありがとうございます！ 

tsoaはいいぞ！APIドキュメントを自動生成！

tsoaはいいぞ！APIドキュメントを自動生成！

ミカイ

More Decks by ミカイ

Featured

Transcript