빠르게 배우고, 빠르게 코딩하며, 빠르게 실행하세요
Django Shinobi - 빠른 Django REST 프레임워크
Django Shinobi는 Django와 Python 3.6+ 타입 힌트를 사용하여 API를 구축하기 위한 웹 프레임워크입니다.
이것은 훌륭한 Django Ninja 라이브러리의 포크로, 커뮤니티가 원하는 기능과 수정 사항에 초점을 맞추고 있습니다. Ninja에서 오신 분들은 차이점 목록과 로드맵을 확인하세요!
주요 특징:
- 쉬움: 사용하기 쉽고 직관적으로 설계되었습니다.
- 빠른 실행: Pydantic과 비동기 지원 덕분에 매우 높은 성능을 자랑합니다.
- 빠른 코딩: 타입 힌트와 자동 문서화로 비즈니스 로직에만 집중할 수 있습니다.
- 표준 기반: API를 위한 공개 표준인 OpenAPI (이전 명칭 Swagger)와 JSON Schema를 기반으로 합니다.
- Django 친화적: (당연히) Django 코어 및 ORM과 좋은 통합성을 가집니다.
- 프로덕션 준비 완료: 원래 Ninja 프로젝트는 여러 기업의 라이브 프로젝트에서 사용되고 있습니다.
문서: https://pmdevita.github.io/django-shinobi
설치
당신의 Django 프로젝트에 Django Shinobi를 추가하세요.
pip install django-shinobipip install django django-shinobi
django-admin startproject apidemo사용법
Django 프로젝트에서 urls.py 옆에 api.py라는 새 파일을 만드세요.
from ninja import NinjaAPIapi = NinjaAPI()
@api.get("/add")
def add(request, a: int, b: int):
return {"result": a + b}
Now go to urls.py and add the following:
``Python hl_lines="3 7"
...
from .api import api
urlpatterns = [ path("admin/", admin.site.urls), path("api/", api.urls), # <---------- ! ]
shell python manage.py runsever `` 이제 http://127.0.0.1:8000/api/docs로 이동하세요끝났습니다!/api/add이제 여러분은 다음과 같은 API를 만들었습니다:
에서 HTTP GET 요청을 받습니다aGET 매개변수 와b를 받아 검증하고 타입 캐스팅합니다결과를 JSON으로 디코딩합니다 정의된 작업에 대한 OpenAPI 스키마를 생성합니다 대화형 API 문서
Django 프로젝트를 실행하세요
자동 상호작용 API 문서가 표시됩니다 (Swagger UI 또는 Redoc 제공):
다음 단계?
- 전체 문서는 여기에서 읽어보세요 - https://pmdevita.github.io/django-shinobi
- 이 프로젝트를 지원하려면 Github에서 별을 눌러주세요.
- 트위터를 통해 공유하세요
- 피드백을 공유하고 개발에 대해 토론하려면 Discord https://discord.gg/ntFTXu7NNv를 방문하세요