https://github.com/mich0232/drf-api-schema-tutorial

Django REST framework OpenAPI schema generation
https://github.com/mich0232/drf-api-schema-tutorial

django django-rest-framework openapi orval react

Last synced: about 2 months ago
JSON representation

Django REST framework OpenAPI schema generation

• Host: GitHub
• URL: https://github.com/mich0232/drf-api-schema-tutorial
• Owner: Mich0232
• Created: 2024-07-19T14:06:08.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-07-21T13:27:59.000Z (6 months ago)
• Last Synced: 2024-10-21T05:18:55.829Z (3 months ago)
• Topics: django, django-rest-framework, openapi, orval, react
• Language: Python
• Homepage:
• Size: 110 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    



# Django REST framework OpenAPI Schema generation

This is a sample project with Django REST framework schema generation and React API client generated from the schema.  

## Technologies

**API**

 - Python 3

 - Django 5

 - Django REST Framework

 - drf-spectacular

Frontend

- React

- orval

- yarn

- Typescript

## Getting started

**Django API**

Create a new Python virtual environment

```shell

python -m venv .venv

```

Activate the virtual environment

```shell

source .venv/bin/activate

```

Install required packages

```shell

python -m pip install -r requirements.txt

```

Run Django server

```shell

python manage.py runserver

```

Frontend application

1. Make sure you have Node installed

2. Install modules `yarn install`

4. Run `yarn dev`