api design best practices

difference and other architectural style For the resource-oriented architectural style of rest, a new architectural concept is proposed, namely: resource-oriented architecture (Roa:resource oriented Architecture) Second, RESTful API design 1. Agreement The API communicates with the user protocol, always using the HTT

RESTFul API design guide and instructions for useRESTFul API design guide and instructions for use I. AgreementThe communication protocol between APIs and users. HTTP is used. 2. Domain NameTry to deploy the API under a dedicated domain name (http://api.example.com)You can a

This article considers the security issue of Open API calls without the use of secure transport protocols. Role definitions Processing flow Caller message Sending Process Publisher message Ingestion Process Call results return process Code Design Caller Code Design Pub

authentication, IP authentication, and so on. You can refer to the design of the GitHub API. It will be in the returned HTTP header information.x-ratelimit-limit:5000x-ratelimit-remaining:4999Represents the maximum number of times that an authorized user has called this interface for a time period of 5,000, remaining 4,999 times in that period. Of course, such validation, plus, will certainly have an impac

Atitit. --- normalization of Api design principles 1.1. called normalization 11.2. Example of normalization: all objects can be serialized /tostring through an interface implementation 11.3. Pan- file concept,21.4. everything in the game industry is elf 21.1. called normalization Interface InheritanceIt is essentially a requirement to "make a good abstraction, which prescribes a compatible interface so

1. Introduction to APIThis time with the external company, has been writing external API interface. The API interface provided is based on the HTTP protocol and is stateless. The authentication information must be brought on each request. The background service verifies the identity information.API authentication based on the HTTP protocol there are many ways, there are HTTP basic,http Digest,

Tag: Digital ANGULARJS represents represent Processor server Post block ICAOAuth 2 and JWT-How to design a secure API?Moakap translation, original OAuth 2 VS JSON Web tokens:how to secure an APIThis article describes in detail two common ways to ensure API security: OAuth2 and JSON Web Token (JWT)Assume: You have or are implementing the

beginning and end. The reason why ASP. NET Web APIs are highly scalable is mainly due to the pipeline design. Although the ASP. NET Web API framework is designed to process requests and respond to requests, the processing policies used vary with specific scenarios. It is impossible and unnecessary to create a "omnipotent" processor to meet all request processing needs. Instead, let a processor be only resp

Atitit. after upgrading the class library framework API Code Compatibility Design Guide1. increase The API directly, the version number is added 1 above the comment 2. Discard APIs, use your ideas @dep13. Modify the API,14. Modify dependent import, ya Yao Add file mode. Maintain compatibility. 15. preferred to

Design principles: A brief discussion of SPI and API background The first time I heard that SPI is reading "The Art of software framework Design," later in the Log4net and quartz.net found in this form of organizing code, the standard gives why to distinguish between SPI and API of a thinking process. speaking from in

being the list is listed first.5. Cache Designwill be explained in detail in each API interface.6. API Interface Design IdeaConsidering the bottleneck of the database at high concurrency, the results of the request need to be cached. The strategy here is:1) Get the data from the cache, the data in the cache is returned directly, or simply processed and then retu

Queue-Related Basics My blog: Queue sequential Storage-design and implementation-API functionsThe queue is also a special linear table and can be used to simulate the chained storage of a queue with linear chain-linked storage.Main code:linkqueue.h//Queue chained Storage API declaration #ifndef _linkqueue_h_#define _linkqueue_h_typedef void linkqueue;//Create que

Modifying data requests(The client provides changed properties) /v1/collection/id Complete object information (in JSON format) 201 (Updated)403 (Forbidden)(Servererror) The following comparison is less used HEAD Get metadata for a resource OPTIONS Get information,The client can modify the property set. Whether success

BOS Project Note 9 daysToday's content arrangement:1. Workflow Concept2. Installation process designer plug-in (Eclipse)---- design Flowchart3. Create a activiti Database ( table)4 . activiti API operation Flow1. Workflow Concepts Work Flow (Workflow) , is " automation of part or whole of a business process in a computer application environment " , it is mainly to solve the " automate the process of passing

about the physical location. The external detection is changed to internal inspection. Yes, the use of people comfortable and happy with ease. God The most important thing is Haisen.Vii. readability of annotations and documentsOne of the best interfaces is that no documentation is required and we will use it, but often the interface is a bit more and the business is increased, and the interface will be a little laborious to use. So the interface documentation and annotations need to be written

request and response JSON message is shown in table 1. You must build the consolidation process to complete the scenario described above. The consolidation process acts as a JSON-based REST API to add two numbers to the external world, as shown in Figure 1. Figure 1. Add two digital-API integration process Design The Receive Input Numbers (receive request

* Read other chapters: http://blog.csdn.net/cuibo1123/article/details/39894477The final thoughtI learned through difficult studies and many years of mistakes. Wrote this article about creating components and API rules. I'm trying to practice my writing skills, although inevitably there are a lot of examples that I haven't mentioned.Not all rules apply in all cases, and no rule is applied under any circumstances. Here is just as much inspiration as you

Rule 1: Use the description term or architecture of the current platformOne of the most common API error designs is the use of foreign rules, APIs belonging to a specific platform and the associated developer ecosystem. You can't use any of the different platform's descriptive terms or architectures, which can contaminate your current code base and disrupt your peers ' productivity.Be fully aware of your target platform and code specifications before

Reprint: Http://www.hutuseng.com/article/how-to-design-api2014, the popularity of mobile apps has not diminished, how to design a good server-side interface (API) for your mobile app? Let's talk about some of my personal ideas.In the 2014, the popularity of mobile apps did not fade, and was not replaced by Web sites like desktop software.Not only that, more and m

We use some commonly used fonts when designing Web pages, and for some fonts that are not commonly used, we can replace them with pictures, and the fonts provided by Google API will not require any pictures, but some fonts that are not used, will be linked to these fonts by Google server when the user opens the page. So that the page is displayed, the user will not feel any discomfort in the process. For many Web designers and developers who are obse