Discover rest api design guidelines, include the articles, news, trends, analysis and practical advice about rest api design guidelines on alibabacloud.com
course, as the basis of design, a few of the principles must be adhered to:
Comply with standards when the standards are reasonable.
The API should be programmer-friendly and easy to enter in the browser's address bar.
The API should be simple, intuitive, easy to use and elegant at the same time.
The API
). The core principle of rest is to split your API into logical resources. These resources are manipulated via HTTP (GET, post,put,delete).
So how do I split these resources?
Obviously from an API user's point of view, "resources" should be a noun. Even if your internal data model and resources already have a good correspondence,
Original address: http://blog.csdn.net/ywk253100/article/details/25654021Guide: Designing restful APIs is critical to the scalability, scalability, and consumer experience of software architectures. The theme of this virtual workshop is how to design restful APIs.Keywords: restful API REST OAuth protocolThe REST archit
Turn from:Bole Online Java API Design ChecklistEnglish original TheamiableapiThere are always a lot of different specifications and considerations when designing Java Apis. As with any complex thing, this work is often a test of the seriousness of our thinking. Just like the Pilot's checklist before takeoff, this checklist will help software designers recall clear or ambiguous specifications as they
the complexity of the app backend, greatly improving the development efficiency of the app front-end.2.8 Points of API design(1) RESTful design principlesRESTful style: restfu design principle, which was put forward by Roy Felding (in his "web-based software Architecture" thesis in the fifth chapter). The core princip
current URL (collection relationship, and gives the collection URL), the href represents the path to the API, title represents the API's caption, and type represents the return type.The design of the Hypermedia API is known as Hateoas. The GitHub API is the design that acce
current URL (collection relationship, and gives the collection URL), the href represents the path to the API, title represents the API's caption, and type represents the return type.The design of the Hypermedia API is known as Hateoas. The GitHub API is the design that acce
have no side effects? It is hard to say no. Due to the lack of cohesion, this API can actually do something else.
Is it reliable?The famous design principle "design to interfaces" helps enforce testability on an object. this API is inherently testable, but the number of test cases to verify may be huge due to its lac
RESTful is the design idea used in both the front-end and back-end interfaces.The website is the software, we also often say webapp, this kind of Internet software uses "the client/server" mode, builds on the distributed system.Web site development, can also fully adopt the model of software development , but the traditional software and networks are different areas, because: software development is mainly for the single-machine environment, and the n
. Most of the time the client just needs some of the information, but the interface still transmits all the information, this situation increases the network transmission, especially for mobile applications are particularly unfriendly, but also require the client to extract the required data. Instead of building two APIs that are roughly the same as the return field, it increases the complexity of the backend implementation, either by adding business logic or by increasing the difficulty of main
API design in the software system in the importance of self-evident, in swift.org saw an "API design Guidelines", although in the case of Swift, but for other languages also have a lot to learn from the place, here roughly translated one or two, for communication purposes, c
architecture style, rest is the abbreviation for representational state transfer, and Chinese translates as "representational states transfer"
Rest looks at the entire network from the resource's perspective, which identifies the resources distributed across a node in the network through URLs, and the client application uses URLs to obtain representations of the resources, resulting in these applicatio
Restful api security design guide
The full name of REST is REpresentational State Transfer, which indicates stateless transmission without session. Therefore, each request must carry authentication information. Rest is based on http and stateless. It is only an architectural method, so its security features must be imp
application state) rule in the URI. There is no direct relationship between the version number and the resource.
URL parameter controlThat is, after each request, add a version parameter that indicates which edition is requested. As follows:http://server:port/api/customer/123?version=2 This approach is actually a variant of the URI pattern, the good and bad are the same.Mdedia Type ControlThat is, using media type in the header of the HTTP requ
Web APIs have become more and more popular in recent years, and the simplicity of API design has become particularly important in multi-backend system interaction applications. In general, RESTful APIs are used as our Web API. This article describes some of the best practices for designing simple RESTful APIs.A noun used instead of a verbUsing nouns to define int
1. If you have already begun to reach out to a friend of the RESTful API design approach, you should first have a general understanding of HTTP/HTTPS, although it has nothing to do with restful APIs. However, to increase the security of the site is very important, here is related to whether to expose the API interface, otherwise it will lead to the disclosure of
The concept of Restful API here does not bother, Bo friends online search ha definition articles a lot, straight into the point:First, throw a question:Judging by the ID of the user, the name is the product of Call of Duty (COD14) exists (say I still like to play like the World War II mission call this amount, off-topic ...)? If this problem occurs in an MVC project, I think we will generally design this:Ap
NET + Offline Salon | Mobile app Mode innovation: give you a reason to do the app >>Good API design: In the self-description, at the same time to achieve abstract goals.Well-designed APIs allow developers to get started quickly, without the need to keep manuals and documentation often, or to visit the tech support community frequently.Smooth interfaceMethod chain: Smooth and easy to read, easier to understa
key to encrypt and decrypt the content of the communication.This trick should be able to let the hacker dumbfounded. But the premise is that the user name and password can not be disclosed.Finally, let's talk about the soap and rest application scenarios,In fact, the essence of SOA is a kind of network function call, if our needs can be abstracted into resources, we can use rest, and the more accurate the
Rest is a software architecture style. The RESTful API is an HTTP protocol-based API and is a stateless transport. Its core is to understand all the APIs as a network resource. Encapsulates the state transitions (actions) of all clients and servers into the Method of HTTP requests.You can read http://mengkang.net/620.html for details.This article is mainly about
The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion;
products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the
content of the page makes you feel confusing, please write us an email, we will handle the problem
within 5 days after receiving your email.
If you find any instances of plagiarism from the community, please send an email to:
info-contact@alibabacloud.com
and provide relevant evidence. A staff member will contact you within 5 working days.