Skip to content

Commit

Permalink
Update OpenAPI_Specification_3.0.3.md (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
ma91n authored Jul 3, 2024
1 parent c02fac2 commit 228b679
Showing 1 changed file with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -327,19 +327,20 @@ API の振る舞いの詳細や注意点を記載する。

API を識別するための一意な文字列を記載する。

- HTTP メソッドと URL パスの組み合わせをアッパーキャメルケースで表現する
- HTTP メソッドと URL パスの組み合わせをキャメルケースで表現する
- キャメルケースの書式は、[OpenAPI 3.0ガイドのPaths and Operations](https://swagger.io/docs/specification/paths-and-operations/#:~:text=role%3Dvalue-,operationId,-operationId%20is%20an)でも利用されているため、一般的である

良い例:

```yaml
paths:
/users:
get:
operationId: GetUsers
operationId: getUsers
...
/products/{product_id}:
put:
operationId: PutProductsProductId
operationId: putProductsProductId
...
```

Expand Down

0 comments on commit 228b679

Please sign in to comment.