apistar

? 웹 API 툴킷. ?

---

커뮤니티: https://discuss.apistar.org ? ? ? ?

문서: https://docs.apistar.com

요구사항: Python 3.6+

---

API Star는 OpenAPI 또는 Swagger 스키마 작업을 위한 툴킷입니다. 이를 통해 다음을 수행할 수 있습니다.

• 사용 가능한 테마를 선택하여 API 문서를 작성하세요.
• API 스키마 문서를 검증하고 상황별 오류를 제공합니다.
• 동적 클라이언트 라이브러리를 사용하여 API 요청을 수행합니다.

이를 사용하여 정적 문서를 작성하거나, 웹 프레임워크 내에 통합하거나, 다른 API와 상호작용하기 위한 클라이언트 라이브러리로 사용할 수 있습니다.

빠른 시작

API 스타 설치:

$ pip3 install apistar

툴킷이 제공하는 일부 기능을 살펴보겠습니다.

OpenAPI 스키마인 schema.yaml 생성하는 것부터 시작하겠습니다.

 openapi : 3.0.0
info :
  title : Widget API
  version : ' 1.0 '
  description : An example API for widgets
servers :
  - url : https://www.example.org/
paths :
  /widgets :
    get :
      summary : List all the widgets.
      operationId : listWidgets
      parameters :
      - in : query
        name : search
        description : Filter widgets by this search term.
        schema :
          type : string

또한 apistar.yml 구성 파일을 생성해 보겠습니다.

 schema :
  path : schema.yaml
  format : openapi

이제 apistar 명령줄 도구를 사용할 준비가 되었습니다.

OpenAPI 스키마를 검증할 수 있습니다.

 $ apistar validate
✓ Valid OpenAPI schema.

또는 API용 개발자 문서를 작성하세요.

 $ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)

또한 스키마에서 참조되는 서버에 API 요청을 할 수도 있습니다.

 $ apistar request listWidgets search=cogwheel

서버는 어디로 갔나요?

버전 0.6부터 API Star 프로젝트는 프레임워크에 구애받지 않는 API 도구 모음으로 초점을 맞추고 있습니다. 계획은 이 기능을 독립형 도구로 사용하거나 다양한 프레임워크와 함께 사용하기에 적합한 방식으로 구축하는 것입니다.

0.5 브랜치는 GitHub에서 계속 사용할 수 있으며 pip install apistar==0.5.41 사용하여 PyPI에서 설치할 수 있습니다. API Star 서버의 추가 개발은 새로운 관리자 하에서 그 포크에 반대해야 할 것입니다.

고성능 Python 기반 비동기 프레임워크를 찾고 있다면 대신 Starlette를 추천합니다.

---

API Star는 BSD 라이센스 코드입니다.
영국 브라이튼에서 설계 및 제작되었습니다.