API

エンドポイント

すべてhttps://artisans.kawax.biz/api以下へ。 認証は不要。CORS対応。レート制限は1分間に60回。

messageのhtmlはサニタイズ後のMarkdownをhtmlに変換してるのでそのまま表示しても安全(バグがなければ)。その他はエスケープが必要。

GET /api/user

ユーザーリストの取得。

レスポンス

{
    "data": [
        {
            "id": "1",
            "name": "test",
            "avatar": "https:\/\/",
            "title": "text",
            "message": "html",
            "url": "http:\/\/",
            "image": "http:\/\/",
            "tags": [
                "tag1",
                "tag2"
            ],
            "created_at": "2019-07-19 02:10:46",
            "updated_at": "2019-07-19 02:10:46"
        }
    ],
    "links": {
        "first": "https:\/\/localhost\/api\/user?page=1",
        "last": "https:\/\/localhost\/api\/user?page=2",
        "prev": null,
        "next": "https:\/\/localhost\/api\/user?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 10,
        "path": "http:\/\/",
        "per_page": 20,
        "to": 20,
        "total": 100
    }
}
                

パラメータ

/api/user?page=2&q=test&limit=100
page
ページ
q
キーワード検索。検索対象は名前とタイトルとメッセージ。
limit
取得件数。指定可能範囲1~100。デフォルト20。

GET /api/post

募集リストの取得。

レスポンス

{
    "data": [
        {
            "id": "1",
            "title": "text",
            "message": "html",
            "url": "http:\/\/",
            "image": "http:\/\/",
            "user": {
                "name": "test",
                "avatar": "https:\/\/"
            },
            "created_at": "2019-07-19 02:10:46",
            "updated_at": "2019-07-19 02:10:46"
        }
    ],
    "links": {
        "first": "https:\/\/localhost\/api\/post?page=1",
        "last": "https:\/\/localhost\/api\/post?page=2",
        "prev": null,
        "next": "https:\/\/localhost\/api\/post?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 10,
        "path": "http:\/\/",
        "per_page": 20,
        "to": 20,
        "total": 100
    }
}
                

パラメータ

/api/post?page=2&q=test&limit=100
page
ページ
q
キーワード検索。検索対象はタイトルとメッセージ。
limit
取得件数。指定可能範囲1~100。デフォルト20。