API Star：一個 Python 3 的 API 框架 | Linux 中國

為了在 Python 中快速構建 API，我主要依賴於 Flask[1]。最近我遇到了一個名為 “API Star” 的基於 Python 3 的新 API 框架。由於幾個原因，我對它很感興趣。首先，該框架包含 Python 新特點，如型別提示和 asyncio。而且它再進一步為開發人員提供了很棒的開發體驗。我們很快就會講到這些功能，但在我們開始之前，我首先要感謝 Tom Christie，感謝他為 Django REST Framework 和 API Star 所做的所有工作。

現在說回 API Star —— 我感覺這個框架很有成效。我可以選擇基於 asyncio 編寫非同步程式碼，或者可以選擇傳統後端方式就像 WSGI 那樣。它配備了一個命令列工具 —— apistar 來幫助我們更快地完成工作。它支援 Django ORM 和 SQLAlchemy，這是可選的。它有一個出色的型別系統，使我們能夠定義輸入和輸出的約束，API Star 可以自動生成 API 的樣式（包括檔案），提供驗證和序列化功能等等。雖然 API Star 專註於構建 API，但你也可以非常輕鬆地在其上構建 Web 應用程式。在我們自己構建一些東西之前，所有這些可能都沒有意義的。

開始

我們將從安裝 API Star 開始。為此實驗建立一個虛擬環境是一個好主意。如果你不知道如何建立一個虛擬環境，不要擔心，繼續往下看。

pip install apistar

（譯註：上面的命令是在 Python 3 虛擬環境下使用的）

如果你沒有使用虛擬環境或者你的 Python 3 的 pip 名為 pip3，那麼使用 pip3 install apistar 代替。

一旦我們安裝了這個包，我們就應該可以使用 apistar 命令列工具了。我們可以用它建立一個新專案，讓我們在當前目錄中建立一個新專案。

apistar new .

現在我們應該建立兩個檔案：app.py，它包含主應用程式，然後是 test.py，它用於測試。讓我們來看看 app.py 檔案：

from apistar import Include, Route
from apistar.frameworks.wsgi import WSGIApp as App
from apistar.handlers import docs_urls, static_urls
def welcome(name=None):
    if name is None:
        return {'message': 'Welcome to API Star!'}
    return {'message': 'Welcome to API Star, %s!' % name}
routes = [
    Route('/', 'GET', welcome),
    Include('/docs', docs_urls),
    Include('/static', static_urls)
]
app = App(routes=routes)
if __name__ == '__main__':
    app.main()

{"message": "Welcome to API Star!"}

{"message": "Welcome to API Star, masnun!"}

from apistar import Route
from apistar.frameworks.wsgi import WSGIApp as App
def user_profile(user_id: int):
    return {'message': 'Your profile id is: {}'.format(user_id)}
routes = [
    Route('/user/{user_id}', 'GET', user_profile),
]
app = App(routes=routes)
if __name__ == '__main__':
    app.main()

{"message": "Your profile id is: 23"}

from apistar import Route
def user_new():
    return {"message": "Create a new user"}
def user_update(user_id: int):
    return {"message": "Update user #{}".format(user_id)}
def user_profile(user_id: int):
    return {"message": "User Profile for: {}".format(user_id)}
user_routes = [
    Route("/new", "GET", user_new),
    Route("/{user_id}/update", "GET", user_update),
    Route("/{user_id}/profile", "GET", user_profile),
]

from apistar import Include
from apistar.frameworks.wsgi import WSGIApp as App
from user import user_routes
routes = [
    Include("/user", user_routes)
]
app = App(routes=routes)
if __name__ == '__main__':
    app.main()

def welcome(name=None):
    if name is None:
        return {'message': 'Welcome to API Star!'}
    return {'message': 'Welcome to API Star, %s!' % name}

from apistar import Include, Route
from apistar.frameworks.wsgi import WSGIApp as App
from apistar import typesystem
class User(typesystem.Object):
    properties = {
    'name': typesystem.string(max_length=100),
    'email': typesystem.string(max_length=100),
    'age': typesystem.integer(maximum=100, minimum=18)
    }
    required = ["name", "age", "email"]
def new_user(user: User):
    return user
routes = [
    Route('/', 'POST', new_user),
]
app = App(routes=routes)
if __name__ == '__main__':
    app.main()

curl -X POST \
  http://127.0.0.1:8080/ \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{"name": "masnun", "email": "masnun@gmail.com", "age": 12}'

from apistar import Route, Response
from apistar.frameworks.wsgi import WSGIApp as App
def hello():
    return Response(
    content="Hello".encode("utf-8"),
    status=200,
    essay-headers={"X-API-Framework": "API Star"},
    content_type="text/plain"
    )
routes = [
    Route('/', 'GET', hello),
]
app = App(routes=routes)
if __name__ == '__main__':
    app.main()