Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Changed title. Added API Endpoint schematics drawing.

  • Loading branch information...
commit 7481cfdd091e84a396b026deceb29e1f8b6a3e8b 1 parent 63044e2
@zdne zdne authored
View
6 _posts/2013-02-19-New-API-Blueprint-Format-Basics.md
@@ -1,5 +1,5 @@
---
-title: New API Blueprint Format – The Basics
+title: New API Blueprint Format Basics
excerpt: Discussing basic features of the New API Blueprint Format – Markdown, API endpoints, multiple requests and responses and commenting on parameters.
layout: post
date: 2014-02-20 09:00:00 +1000
@@ -19,6 +19,10 @@ An endpoint usually represents a resource on the server. It is represented by an
In API Blueprint an API endpoint is defined as a Markdown header with optional HTTP method followed by an URI. After the header follows structured discussion of the endpoint. The endpoint discussion consists of sections of predefined meaning. These sections are delimited by a nested Markdown headers with reserved section names (e.g. `## Request`). Finally, the API endpoint is closed by Markdown's horizontal ruler.
+API Endpoint structure:
+
+![API Endpoint Structure](/images/2013-02-19-API-endpoint.png)
+
For example:
# GET /message_of_the_day
View
BIN  images/2013-02-19-API-endpoint.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Please sign in to comment.
Something went wrong with that request. Please try again.