acacode / acacode/swagger-typescript-api
Option for handle object without $ref (nested objects)
- Vorherrschende Sprache
- TypeScript
- Sterne
- 4.1k
- Forks
- 436
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
When generating the client, we pass the swagger. A swagger can include complex objects. Such objects usually have nested objects. So, if we want to access this nested object from code, then we can only get it if it is described inside the swagger using "$ref".
Example object in schema (without $ref)
```json
"work_day": {
"type": "object",
"description": "Workday state",
"properties": {
"uuid": {
"type": "string",
"description": "Workday uuid",
"example": "6e8242b9-adea-4d0a-ba74-07dc2cf6f459"
}
}
}
```
We generate some schema and result is:
```typescript
export interface Generated {
name?: string;
work_day?: {
uuid?: string;
};
}
```
But now, let use $ref inside our schema
```json
"work_day": {
"schema": {
"$ref": "#/components/schemas/Workday"
}
}
```
Result in TypeScript:
```typescript
export interface Generated {
name?: string;
work_day?: GeneratedWorkDay;
}
export interface GeneratedWorkDay {
uuid?: string;
}
```
It is possible to handle object without $ref?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Bewertung
Dieses Issue wurde noch nicht bewertet.