acacode / acacode/swagger-typescript-api

Option for handle object without $ref (nested objects)

Ouverte
#639 1 commentaire 2 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
4.1k
Forks
436
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.