{"info":{"_postman_id":"2057a728-e43c-4b90-a43f-52658b45c94e","name":"Simple Blog API","description":"

Feel free to review this documentation for this simple API.

The blog is a small app hosted on Heroku, and is meant to be a nice testing ground for making a very simple front-end which consumes API data created via a different request.

Here's an example of using this API with the the Javascript fetch object:

fetch('https://hp-sample-blog.herokuapp.com/posts', { method: 'GET' })\n  .then(async (response) => {\n    // inspect the response headers\n    const page = await response.headers.get('page');\n    const total = await response.headers.get('total');\n    const perPage = await response.headers.get('per-page');\n    // get the response body in JSON\n    const body = await response.json();\n    return { headers: { page, total, perPage }, body };\n  })\n  .then(data => console.log(data)) // Log the output\n  .catch(error => console.error(error));\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2582145","collectionId":"2057a728-e43c-4b90-a43f-52658b45c94e","publishedId":"TzCQbn5S","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-05T19:05:18.000Z"},"item":[{"name":"List Posts","id":"a797770e-a24e-4d7e-8dfd-a60671383c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hp-sample-blog.herokuapp.com/posts","description":"

List all the posts on the website.

This list is paginated, and by default returns a list of 25 posts. To change the number of posts per page, and to request a different page, you can pass some parameters:

per_page: Returns the number of posts you specify (like 25 or 100). Defaults to 25
page: Returns the given page of results (like ?page=2 or ?page=3). Defaults to 1

Using the page headers, you can determine whether pagination is necessary. There are a handful of HTTP headers in the response you may find useful:

Page: The current page being requested
Total: The total number of posts
Per-Page: The number of posts to be returned per page.

\n","urlObject":{"protocol":"https","path":["posts"],"host":["hp-sample-blog","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"ad1bbdbb-f9e5-41d7-859b-51bddd689c83","name":"List Posts","originalRequest":{"method":"GET","header":[],"url":"https://hp-sample-blog.herokuapp.com/posts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Per-Page","value":"25"},{"key":"Page","value":"1"},{"key":"Total","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"ETag","value":"W/\"ca653219d88be7a3cc87ccc532049532\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e841759f-525d-431e-aace-47ae9ce32971"},{"key":"X-Runtime","value":"0.015041"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"**Some bold**\\n More content and stuff\",\n \"content_html\": \"

Some bold\\nMore content and stuff

\\n\",\n \"created_at\": \"2021-04-05T18:12:39.762Z\",\n \"updated_at\": \"2021-04-05T18:28:17.624Z\",\n \"url\": \"http://localhost:3000/posts/1.json\"\n }\n]"}],"_postman_id":"a797770e-a24e-4d7e-8dfd-a60671383c5f"},{"name":"Update a Post","id":"2eb7f740-cfee-498c-9fae-3cb12092e206","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hp-sample-blog.herokuapp.com/posts/1","description":"

Creates a single blog post

\n","urlObject":{"protocol":"https","path":["posts","1"],"host":["hp-sample-blog","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"103c7cbd-aa04-4b1a-9ecc-14809d4fd37d","name":"Update a Post","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hp-sample-blog.herokuapp.com/posts/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Location","value":"http://localhost:3000/posts/1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"ETag","value":"W/\"254fdce09f22c304e246f29114ea654f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b2c4be6f-d261-4bfe-8253-dfef74a239c0"},{"key":"X-Runtime","value":"0.009546"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\",\n \"content_html\": \"

Some bold

\\n

More content and stuff

\\n\",\n \"created_at\": \"2021-04-05T18:12:39.762Z\",\n \"updated_at\": \"2021-04-05T18:40:39.075Z\",\n \"url\": \"http://localhost:3000/posts/1.json\"\n}"}],"_postman_id":"2eb7f740-cfee-498c-9fae-3cb12092e206"},{"name":"Create a post","id":"08a3671b-f503-4569-8def-20af0a8381c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"A quick example blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hp-sample-blog.herokuapp.com/posts","description":"

Creates a single blog post

\n","urlObject":{"protocol":"https","path":["posts"],"host":["hp-sample-blog","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"23237d1c-1d69-46dd-a805-7d5ba195f8f6","name":"Create a Post","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hp-sample-blog.herokuapp.com/posts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Location","value":"http://localhost:3000/posts/1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"ETag","value":"W/\"254fdce09f22c304e246f29114ea654f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b2c4be6f-d261-4bfe-8253-dfef74a239c0"},{"key":"X-Runtime","value":"0.009546"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"title\": \"How not to write a blog post\",\n \"description\": \"This is an awesome description\",\n \"image_url\": \"https://images.unsplash.com/photo-1592136187769-65d502332dc6\",\n \"content_markdown\": \"## Some bold\\n\\n More content and stuff\",\n \"content_html\": \"

Some bold

\\n