The following example illustrates a get method that includes a brief display name and description with reserved and custom parameter names as well as corresponding HTTP code and error codes: Within those categories, I group the files based on the method or action. Collection returns a summary, whereas member returns an object. I’ve categorized it into two sections or parts – collection and member. This asset provides a basic set of RAML fragments such as resource types and traits to be used as a common RAML fragment dependency in all API’s to ensure consistency and increased speed of development with regards to RAML specifications. In this section, I’ll discuss three API fragments that are a part of the design strategies – Commons, Security, and Domain fragments. The top layer, which is the actual RAML specification, will simply extend the underlying API fragments. The middle layer includes Domain fragments which represent a specific backend system’s common data types and examples that will be used by multiple System APIs integration to a particular domain. As seen in the image below, the bottom layer contains the API fragments that will be used across all API specifications. For example, I had Commons, Security, and Domain fragments. To speed up designing and creating a RAML specification, I created a new design strategy by building multiple API fragments based on their usage. Reusable APIs and API fragments are critical factors in closing the IT delivery gap. which result in API specification.ĪPI fragments are portion of API specifications - they provide a way to create APIs more efficiently is to get reuse by reusing portions or fragments of APIs into specs. Here, we identify process and business requirements, create logical data models, model API resources, operations/methods, request/response/payload/ codes, etc. The first stage in the lifecycle of an application building block is design. In this blog, I’ll walk you through the strategies in designing your API fragments, following the REST standards.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |