acacode / acacode/swagger-typescript-api

[Feature request] Discriminated unions on status for error or success responses

オープン
#227 コメント 3 件 リアクション 6 件 担当者 0 名 GitHub で見る
enhancement
主要言語
TypeScript
スター
4.1k
フォーク
436
PR マージ指標
30日以内にマージされた PR はありません

説明

How would the swagger-typescript-api team feel about having the `status` from the response as a typescript union discriminant where rest of the props would be defined based on its value?

For example, if the `swagger.json` file contains this for a given api call -

```json
"responses": {
"200": {
"description": "Resource is successfully created.",
"schema": { "$ref": "#/definitions/ResourceSuccessResponse" }
},
"400": {
"description": "Create resource request has invalid fields.",
"schema": { "$ref": "#/definitions/ErrorResponse" }
},
"401": {
"description": "Create resource request has invalid user credentials.",
"schema": { "$ref": "#/definitions/ErrorResponse" }
},
"409": {
"description": "Resource name already exists.",
"schema": { "$ref": "#/definitions/ErrorResponse" }
}
}
```

hypothetically the response could be of this format -

```ts
type HttpResponseType = {
status: Status,
data: ResponseData
}

type ResourceCreationResponse =
| HttpResponseType<200, ResourceSuccess>
| HttpResponseType<400, ErrorResponse>
| HttpResponseType<401, ErrorResponse>
| HttpResponseType<409, ErrorResponse>

type ResourceSuccess = {
resource: string
}

type ErrorResponse = {
code: number
message: string
}

declare const a: MyApiCallResponseType;

if(a.status === 200) {
console.log(a.data) // `a.data` is of type ResourceSuccess now
}
```

This could also be an option if not the default.

I would be willing to make a PR for this if this seems like a good idea. It definitely makes the resulting types stronger in my experience with slight flexibility cost.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。