Specification

In addition to the documentation on this page, you can also download a spec file describing the API:

Resources

Entry

Get an entry

Curl request

$ curl 'https://blog-api.ik.am:443/entries/99999' -i -X GET

HTTP request

GET /entries/99999 HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Last-Modified: Sat, 1 Apr 2017 02:00:00 +0900
Expires: Sat, 1 Apr 2017 02:00:00 +0900
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Content-Length: 584
X-XSS-Protection: 1 ; mode=block
Cache-Control: max-age=0

{
  "entryId" : 99999,
  "content" : "This is a test data.",
  "created" : {
    "name" : "making",
    "date" : "2017-04-01T01:00:00+09:00"
  },
  "updated" : {
    "name" : "making",
    "date" : "2017-04-01T02:00:00+09:00"
  },
  "frontMatter" : {
    "title" : "Hello World!!",
    "tags" : [ {
      "tag" : {
        "name" : "test1"
      }
    }, {
      "tag" : {
        "name" : "test2"
      }
    }, {
      "tag" : {
        "name" : "test3"
      }
    } ],
    "categories" : [ {
      "name" : "x"
    }, {
      "name" : "y"
    }, {
      "name" : "z"
    } ]
  }
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/entries/99999'

Response body

{
  "entryId" : 99999,
  "content" : "This is a test data.",
  "created" : {
    "name" : "making",
    "date" : "2017-04-01T01:00:00+09:00"
  },
  "updated" : {
    "name" : "making",
    "date" : "2017-04-01T02:00:00+09:00"
  },
  "frontMatter" : {
    "title" : "Hello World!!",
    "tags" : [ {
      "tag" : {
        "name" : "test1"
      }
    }, {
      "tag" : {
        "name" : "test2"
      }
    }, {
      "tag" : {
        "name" : "test3"
      }
    } ],
    "categories" : [ {
      "name" : "x"
    }, {
      "name" : "y"
    }, {
      "name" : "z"
    } ]
  }
}

Response fields

Path Type Description

entryId

Number

Entry ID

content

String

Content

frontMatter.title

String

Title

frontMatter.categories

Array

Categories

frontMatter.categories[].name

String

Category name

frontMatter.tags

Array

Tags

frontMatter.tags[].tag

Object

A tag

frontMatter.tags[].tag.name

String

Tag name

created.name

String

Creator’s name

created.date

String

Created date

updated.name

String

Updater’s name

updated.date

String

Updated date

Get entries

Curl request

$ curl 'https://blog-api.ik.am:443/entries' -i -X GET

HTTP request

GET /entries HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2200
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/entries'

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Get entries by tag

Curl request

$ curl 'https://blog-api.ik.am:443/tags/test3/entries' -i -X GET

HTTP request

GET /tags/test3/entries HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 1639
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/tags/test3/entries'

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Get entries by categories

Curl request

$ curl 'https://blog-api.ik.am:443/categories/x%2Cy/entries' -i -X GET

HTTP request

GET /categories/x%2Cy/entries HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 1639
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/categories/x%2Cy/entries'

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Get entries by created by

Curl request

$ curl 'https://blog-api.ik.am:443/users/making/entries' -i -X GET

HTTP request

GET /users/making/entries HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1668
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/users/making/entries'

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 2,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 2,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Get entries by update by

Curl request

$ curl 'https://blog-api.ik.am:443/users/making/entries?updated&updated=io.restassured.internal.NoParameterValue%404037fcc' -i -X GET

HTTP request

GET /users/making/entries?updated&updated=io.restassured.internal.NoParameterValue%404037fcc HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2200
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/users/making/entries?updated&updated=io.restassured.internal.NoParameterValue%404037fcc'

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Search entries

Curl request

$ curl 'https://blog-api.ik.am:443/entries?q=test&excludeContent=true' -i -X GET

HTTP request

GET /entries?q=test&excludeContent=true HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2200
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

HTTPie request

$ http GET 'https://blog-api.ik.am:443/entries?q=test&excludeContent=true'

Request parameters

Parameter Description

q

A search query

excludeContent

Whether the entry includes content (true/false)

Response body

{
  "content" : [ {
    "entryId" : 99999,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T01:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T02:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Hello World!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      }, {
        "name" : "z"
      } ]
    }
  }, {
    "entryId" : 99998,
    "content" : "",
    "created" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-04-01T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "Test!!",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test2"
        }
      } ],
      "categories" : [ {
        "name" : "a"
      }, {
        "name" : "b"
      }, {
        "name" : "c"
      } ]
    }
  }, {
    "entryId" : 99997,
    "content" : "",
    "created" : {
      "name" : "admin",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "updated" : {
      "name" : "making",
      "date" : "2017-03-31T00:00:00+09:00"
    },
    "frontMatter" : {
      "title" : "CategoLJ 4",
      "tags" : [ {
        "tag" : {
          "name" : "test1"
        }
      }, {
        "tag" : {
          "name" : "test3"
        }
      } ],
      "categories" : [ {
        "name" : "x"
      }, {
        "name" : "y"
      } ]
    }
  } ],
  "pageable" : {
    "sort" : {
      "unsorted" : true,
      "sorted" : false,
      "empty" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false,
    "pageNumber" : 0,
    "pageSize" : 10
  },
  "totalElements" : 3,
  "totalPages" : 1,
  "last" : true,
  "first" : true,
  "sort" : {
    "unsorted" : true,
    "sorted" : false,
    "empty" : true
  },
  "size" : 10,
  "number" : 0,
  "numberOfElements" : 3,
  "empty" : false
}

Response fields

Path Type Description

content[].entryId

Number

Entry ID

content[].content

String

Content

content[].frontMatter.title

String

Title

content[].frontMatter.categories

Array

Categories

content[].frontMatter.categories[].name

String

Category name

content[].frontMatter.tags

Array

Tags

content[].frontMatter.tags[].tag

Object

A tag

content[].frontMatter.tags[].tag.name

String

Tag name

content[].created.name

String

Creator’s name

content[].created.date

String

Created date

content[].updated.name

String

Updater’s name

content[].updated.date

String

Updated date

last

Boolean

Is last

first

Boolean

Is first

totalPages

Number

Total pages

totalElements

Number

Total elements

size

Number

Size

number

Number

Number

numberOfElements

Number

Number of elements

pageable.sort.sorted

Boolean

Is sorted

pageable.sort.unsorted

Boolean

Is unsorted

pageable.offset

Number

Offset

pageable.pageSize

Number

Page size

pageable.pageNumber

Number

Page number

pageable.paged

Boolean

Is paged

pageable.unpaged

Boolean

Is unpaged

pageable.sort.empty

Boolean

Whether the pageable.sort is empty or not

sort.sorted

Boolean

Is sorted

sort.unsorted

Boolean

Is unsorted

sort.empty

Boolean

Whether the sort is empty or not

empty

Boolean

Whether the content is empty or not

Tag

Curl request

$ curl 'https://blog-api.ik.am:443/tags' -i -X GET

HTTP request

GET /tags HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Length: 128
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

[ {
  "tag" : {
    "name" : "test1"
  }
}, {
  "tag" : {
    "name" : "test2"
  }
}, {
  "tag" : {
    "name" : "test3"
  }
} ]

HTTPie request

$ http GET 'https://blog-api.ik.am:443/tags'

Response body

[ {
  "tag" : {
    "name" : "test1"
  }
}, {
  "tag" : {
    "name" : "test2"
  }
}, {
  "tag" : {
    "name" : "test3"
  }
} ]

Response fields

Path Type Description

[].tag

Object

A tag

[].tag.name

String

Tag name

Category

Curl request

$ curl 'https://blog-api.ik.am:443/categories' -i -X GET

HTTP request

GET /categories HTTP/1.1
Host: blog-api.ik.am:443

HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Referrer-Policy: no-referrer
Content-Length: 269
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
X-XSS-Protection: 1 ; mode=block

[ {
  "categories" : [ {
    "name" : "a"
  }, {
    "name" : "b"
  }, {
    "name" : "c"
  } ]
}, {
  "categories" : [ {
    "name" : "x"
  }, {
    "name" : "y"
  } ]
}, {
  "categories" : [ {
    "name" : "x"
  }, {
    "name" : "y"
  }, {
    "name" : "z"
  } ]
} ]

HTTPie request

$ http GET 'https://blog-api.ik.am:443/categories'

Response body

[ {
  "categories" : [ {
    "name" : "a"
  }, {
    "name" : "b"
  }, {
    "name" : "c"
  } ]
}, {
  "categories" : [ {
    "name" : "x"
  }, {
    "name" : "y"
  } ]
}, {
  "categories" : [ {
    "name" : "x"
  }, {
    "name" : "y"
  }, {
    "name" : "z"
  } ]
} ]

Response fields

Path Type Description

[].categories

Array

Categories

[].categories[].name

String

Category name