Question

我不想写一本书,我想我会找到一些好的建议,说明如何写好一本书。

当然,我进行了权宜之计的搜索,但从Dustin Diaz 中删除。我确实未能找到好的建议。

What are things that you wish you had done differently when creating an API? What made the biggest difference.

我假定我会使用 o。

我无意中不提供复印件的细节,因为我期望提出更多的一般性建议,希望这些建议对更多人有用。

Answer 1

要点我建议你研究:

Implement a RESTful interface
Offer a variety of data formats (JSON, XML, etc)
Make the syntax intuitive and easy to understand
Thorough documentation
Use proper response codes

此外,你认为,在这方面有一些联系是有益的:

http://www.slideshare.net/eaton/building-apis-that-rock
http://www.notiondesign.ca/blog/story/how-not-to-build-an-api/
http://blog.apigee.com/category/api_best_practices/
http://blog.isnotworking.com/2007/05/api-design-guidelines.html

此外,这本大书有助于你启动:

http://www.amazon.com/dp/0596529260/

Answer 2

I don t think the language-agnostic tag is appropriate for this question, and moreover, it needs a specific language tag. Designing a good API requires a consideration of the characteristics and idioms of the language you re working with. Some of the most important considerations:

whether memory is managed manually, with RAII, or with garbage collection.
support for generic programming, object oriented programming, functional programming, etc. in the language.
what type system the language uses.

So the best piece of advice I can offer to your question as it stands (language-agnostic) is not to assume there are language-agnostic universal API design guidelines, and instead get to know the language(s) you re working with and the appropriate idioms.

Answer 3

API must be clear Easy to learn Easy to use, even without documentation Hard to misuse Functionality should be easy to explain Names should be largely self-explanatory Names should be consistent: the same word should mean the same thing through the whole API API should be regular, have some symmetry

给予信贷

http://sharismlab.com/blog/2012/07/21/how-to-write-an-api-for-your-web-app/

Answer 4

Understand how users are going to use your application. If you can able to note down all the usecases of your application then you can implement each usecase as part of API. At the end of the day you will have an API which provides set of usecases that you decided. Further you should able to extend API with expansion of usecases and should be able to maintain backward compatibility.

API implementation for Web services:
Decide which protocol, data formats and authentication you need to use.
Most of the web services implement API with following parameters.

Protocol: HTTP
Dataformat : JSON/XML
Authentication : API key/Oauth

API implementation for libraries and SDK:
Create prototypes which should be frozen through out life.
Expand API by adding extra functions and do not change existing functions prototypes.
Allow users to provide as many inputs they can as arguments to functions. So the application can do its job as user requested to do.

Keep user in mind and API should allow user to use it with minimum effort.

Refer:
An Introduction to APIs : https://zapier.com/learn/apis

友情链接