API仕様書

Django REST Frameworkにて作成したAPIの簡単な仕様書である

APIの動作チェック方法

Django REST Frameworkの機能を用いる方法

localにてDEBUGモードにてサーバーを起動時にAPIをブラウザーから叩くことで以下のような画面が現れる

ここからGETやPOST、PUTなど基本的な操作のテストが可能である。
しかし、認証が必要な項目のテストはできないためおすすめできない。以下の二つの方法をおすすめする。

Advanced REST API Client などのソフトを使う

Google Chromeのアプリとして利用できる。 割とおすすめ。

curl

上記のクライアントソフトを使えない環境、マウスを使うのがいやであるなら、使っても良いかも。

API

認証周り

JWT token 作成

そのうちかく

JWT token チェック

そのうちかく

JWT token リフレッシュ

そのうちかく

Work

WorkItem

url: /api/v1/work/item
json:

{
    "name": "workname",
    "tools": [1,2],
    "user": 1,
    "intro": "worknameはworknameです。MDも入れれます",
    "tags": [1,2],
    "files": [3],
    "created_at": "2019-11-04"
}

get-all-json:

{
    "count": 1,
    "next": "/api/v1/work/item/?page=5",
    "previous": "/api/v1/work/item/?page=3",
    "results": [
        {
            "name": "workname",
            "tools": [1,2],
            "user": 1,
            "intro": "worknameはworknameです。MDも入れれます",
            "tags": [1,2],
            "files": [3],
            "created_at": "2019-11-04"
        }
    ]
}

使用できるメソッド: GET(All), GET(詳細), POST, PUT, DELETE

WorkTag