Skip to content

Commit 4050ee2

Browse files
committed
Merge pull request project-open-data#169 from vurcease/patch-1
Updated api-basics.md: Repaired dead links by replacing them with links ...
2 parents d8b92b6 + c89bad4 commit 4050ee2

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

api-basics.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,21 @@ Many of these pioneers have shaped the way in which we develop, deploy, consume,
5959

6060
### What technology goes into an API?
6161

62-
APIs are driven by a set of specific technologies, making them easily understood by developers. This type of standardization means that APIs can work with common programming languages. The most popular approach to delivering web APIs is:
62+
APIs are driven by a set of specific technologies, making them easily understood by developers. This type of focus means that APIs can work with any common programming language, with the most popular approach to delivering web APIs being REST, or [REpresentational State Transfer](http://en.wikipedia.org/wiki/Representational_state_transfer).
6363

64-
* [Pragmatic REST](http://apievangelist.com/buildingblocks/pragmatic_rest.php)
64+
REST takes advantage of the same Internet mechanisms that are used to view regular web pages, giving it many advantages, that can result in faster implementations and easier for developers to understand and use. REST APIs allow you to take data and functionality that may already be available on your website and make them available through a programmatic API, that both web and mobile applications can use. Then, instead of returning HTML to represent the information like a website would, an API returns data in one of two possible formats:
65+
* [Extensible Markup Language (XML)](http://en.wikipedia.org/wiki/Xml)
66+
* [JavaScript Object Notation (JSON)](http://en.wikipedia.org/wiki/JSON)
6567

66-
Since REST takes advantage of the same Internet mechanisms that are used to view regular web pages it has many advantages, resulting in faster implementations and and ease of use for developers. REST APIs allow you to take data and functionality available on your website and make these resources available through a Web API. Then, instead of returning HTML to represent these resources, the API returns data in one of two possible formats:
68+
Developers can then take this data and use in web and mobile applications. However XML and JSON are easily consumed by spreadsheets and other tools non-developers can use as well, making APIs accessible by potentially anyone.
6769

68-
<ul>
69-
<li><a href="http://apievangelist.com/buildingblocks/extensible_markup_language_(xml).php">Extensible Markup Language (XML)</a></li>
70-
<li><a href="http://apievangelist.com/buildingblocks/javascript_object_notation_(json).php">JavaScript Object Notation (JSON)</a></li>
71-
</ul>
70+
Easy access to all this data and resources is great, but sometimes we need to control access to APIs. There are two primary ways to secure an API by providing authentication using:
71+
* [Basic Auth](http://en.wikipedia.org/wiki/Basic_auth)
72+
* [OAuth](http://en.wikipedia.org/wiki/Oauth)
7273

73-
Developers can then take this data and use it in web and mobile applications. In addition, XML and JSON are easily consumed by spreadsheets and other tools non-developers can use as well, making APIs accessible by anyone.
74-
75-
76-
REST with JSON has become the favorite of developers and API owners because it is easier to both deploy and consume than other implementations. Even though REST + JSON is not a standard, it is seeing wide acceptance across the industry.
74+
REST with JSON has become the favorite of developers and API owners, because it is easier to both deploy and consume than other implementations. Even though REST + JSON is not a standard, it is seeing wide acceptance across the industry.
7775

76+
The technology that are commonly found in APIs was not designated by a single standards body or by a single company, it is based upon emulating the best practices of existing, successful providers over the last 13 years.
7877
### When Things Go Wrong — Error Handling
7978

8079
One of the most important issues to remember in API strategy is that developers need to handle what happens when an error occurs otherwise access to data fails and subsequently so does the application. For the purposes of the service framework, an error is defined as an unexpected behavior that occurred during the process of a request. It's important to note that what might be considered an "error" can often be an expected behavior.

0 commit comments

Comments
 (0)