しずかなインターネット API (1.0.0)

Download OpenAPI specification:Download

  • このAPIは自分の記事データを取得するために利用します。他のユーザーのデータを取得することはできません。
  • APIはプロジェクトのスポンサーのみが利用できます。
  • 認証やレート制限などについてはGitHubリポジトリを参照してください。

posts

記事の一覧を取得する

  • 自分の記事一覧を取得するためのエンドポイントです。
Authorizations:
bearerAuth
query Parameters
page
integer [ 1 .. 999 ]
Default: 1

ページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

1ページあたりの記事数

sort
string
Enum: "created" "updated"

ソートの基準(作成日または更新日)

direction
string
Enum: "asc" "desc"

ソートの方向(昇順または降順)

visibility
string
Enum: "MYSELF" "ANYONE" "URL_ONLY"

記事の公開範囲

  • MYSELF: 自分だけ(非公開)
  • ANYONE: みんな(公開)
  • URL_ONLY: URLを知っている人だけ(URL限定公開)
createdAfter
string <date-time>

指定日時以降に作成された記事を取得。ISO 8601形式で指定する。

createdBefore
string <date-time>

指定日時以前に作成された記事を取得。ISO 8601形式で指定する。

updatedAfter
string <date-time>

指定日時以降に更新された記事を取得。ISO 8601形式で指定する。

updatedBefore
string <date-time>

指定日時以前に更新された記事を取得。ISO 8601形式で指定する。

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

記事の詳細情報を取得する

指定されたslugの記事の詳細情報を取得するためのエンドポイントです。

Authorizations:
bearerAuth
path Parameters
slug
required
string [ 1 .. 100 ] characters

記事のslug

Responses

Response samples

Content type
application/json
{
  • "post": {
    }
}