Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phillipdupuis/pydantic-to-typescript
CLI Tool for converting pydantic models into typescript definitions
https://github.com/phillipdupuis/pydantic-to-typescript
converting-pydantic-models fastapi python type-hints typescript typescript-definitions validation
Last synced: 21 days ago
JSON representation
CLI Tool for converting pydantic models into typescript definitions
- Host: GitHub
- URL: https://github.com/phillipdupuis/pydantic-to-typescript
- Owner: phillipdupuis
- License: mit
- Created: 2020-05-23T15:06:42.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T12:32:21.000Z (6 months ago)
- Last Synced: 2024-04-14T12:21:46.729Z (2 months ago)
- Topics: converting-pydantic-models, fastapi, python, type-hints, typescript, typescript-definitions, validation
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 239
- Watchers: 8
- Forks: 33
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-fastapi - :octocat: pydantic-to-typescript :star: 100+ :fork_and_knife: 10+ - CLI Tool for converting pydantic models into typescript definitions. (Commands)
README
# pydantic-to-typescript
[](https://badge.fury.io/py/pydantic-to-typescript)
[](https://github.com/phillipdupuis/pydantic-to-typescript/actions/workflows/cicd.yml)
[](https://coveralls.io/github/phillipdupuis/pydantic-to-typescript?branch=master)
A simple CLI tool for converting pydantic models into typescript interfaces. Useful for any scenario in which python and javascript applications are interacting, since it allows you to have a single source of truth for type definitions.
This tool requires that you have the lovely json2ts CLI utility installed. Instructions can be found here: https://www.npmjs.com/package/json-schema-to-typescript
### Installation
```bash
$ pip install pydantic-to-typescript
```
---
### CLI
| Prop | Description |
| :------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ‑‑module | name or filepath of the python module you would like to convert. All the pydantic models within it will be converted to typescript interfaces. Discoverable submodules will also be checked. |
| ‑‑output | name of the file the typescript definitions should be written to. Ex: './frontend/apiTypes.ts' |
| ‑‑exclude | name of a pydantic model which should be omitted from the resulting typescript definitions. This option can be defined multiple times, ex: `--exclude Foo --exclude Bar` to exclude both the Foo and Bar models from the output. |
| ‑‑json2ts‑cmd | optional, the command used to invoke json2ts. The default is 'json2ts'. Specify this if you have it installed locally (ex: 'yarn json2ts') or if the exact path to the executable is required (ex: /myproject/node_modules/bin/json2ts) |
---
### Usage
Define your pydantic models (ex: /backend/api.py):
```python
from fastapi import FastAPI
from pydantic import BaseModel
from typing import List, Optional
api = FastAPI()
class LoginCredentials(BaseModel):
username: str
password: str
class Profile(BaseModel):
username: str
age: Optional[int]
hobbies: List[str]
class LoginResponseData(BaseModel):
token: str
profile: Profile
@api.post('/login/', response_model=LoginResponseData)
def login(body: LoginCredentials):
profile = Profile(**body.dict(), age=72, hobbies=['cats'])
return LoginResponseData(token='very-secure', profile=profile)
```
Execute the command for converting these models into typescript definitions, via:
```bash
$ pydantic2ts --module backend.api --output ./frontend/apiTypes.ts
```
or:
```bash
$ pydantic2ts --module ./backend/api.py --output ./frontend/apiTypes.ts
```
or:
```python
from pydantic2ts import generate_typescript_defs
generate_typescript_defs("backend.api", "./frontend/apiTypes.ts")
```
The models are now defined in typescript...
```ts
/* tslint:disable */
/**
/* This file was automatically generated from pydantic models by running pydantic2ts.
/* Do not modify it by hand - just update the pydantic models and then re-run the script
*/
export interface LoginCredentials {
username: string;
password: string;
}
export interface LoginResponseData {
token: string;
profile: Profile;
}
export interface Profile {
username: string;
age?: number;
hobbies: string[];
}
```
...and can be used in your typescript code with complete confidence.
```ts
import { LoginCredentials, LoginResponseData } from "./apiTypes.ts";
async function login(
credentials: LoginCredentials,
resolve: (data: LoginResponseData) => void,
reject: (error: string) => void
) {
try {
const response: Response = await fetch("/login/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(credentials),
});
const data: LoginResponseData = await response.json();
resolve(data);
} catch (error) {
reject(error.message);
}
}
```