aspnet-minimal-api-openapi
ASP.NET Minimal APIのエンドポイントを、適切なOpenAPIドキュメントを付与した形で作成します。エンドポイントの定義からスキーマ・レスポンス型の記述まで、OpenAPI仕様に準拠した実装を自動生成します。
description の原文を見る
Create ASP.NET Minimal API endpoints with proper OpenAPI documentation
SKILL.md 本文
ASP.NET Minimal API with OpenAPI
あなたは、適切なタイプと包括的な OpenAPI/Swagger ドキュメンテーションを備えた、よく構造化された ASP.NET Minimal API エンドポイントの作成を支援することが目標です。
API Organization
MapGroup()拡張機能を使用して関連するエンドポイントをグループ化する- 横断的関心事のためにエンドポイントフィルターを使用する
- 大規模な API は個別のエンドポイントクラスで構造化する
- 複雑な API にはフィーチャーベースのフォルダ構造の使用を検討する
Request and Response Types
- 明示的なリクエスト/レスポンス DTO/モデルを定義する
- 適切な検証属性を持つクリアなモデルクラスを作成する
- 不変のリクエスト/レスポンスオブジェクトにはレコード型を使用する
- API 設計基準に合わせた有意義なプロパティ名を使用する
[Required]および他の検証属性を適用して制約を強制する- ProblemDetailsService と StatusCodePages を使用して標準エラーレスポンスを取得する
Type Handling
- 明示的な型バインディングを使用して強く型付けされたルートパラメーターを使用する
Results<T1, T2>を使用して複数のレスポンス型を表現するResultsの代わりにTypedResultsを返して強く型付けされたレスポンスを実現する- nullable アノテーションと init のみのプロパティなど、C# 10+ の機能を活用する
OpenAPI Documentation
- .NET 9 で追加された組み込み OpenAPI ドキュメントサポートを使用する
- 操作の summary と description を定義する
WithName拡張メソッドを使用して operationIds を追加する[Description()]でプロパティおよびパラメーターに説明を追加する- リクエストおよびレスポンスに適切なコンテンツタイプを設定する
- ドキュメントトランスフォーマーを使用して、サーバー、タグ、セキュリティスキームなどの要素を追加する
- スキーマトランスフォーマーを使用して OpenAPI スキーマにカスタマイズを適用する
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- github
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/github/awesome-copilot / ライセンス: MIT
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理（非同期ジェネレータを含む）、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。