Best practices for Creating Web APIs

 

 Best Practices for Appian developers

Appian best practices are like a check list, use these checklists at different stages of your development cycle as described to ensure application success and reduce technical risk. Each section provides guidance for when and how often you should use these.

13.Best practices for Creating Web APIs :-

1.Ensure that proper security is configured

2.Expression may not be longer than 4,000 characters.

3.Custom Status Code can be defined in the response to handle the custom validations message based on the returned status code

4.All Web APIs must return an HTTP Response.

5.Use WEB API when REST/HTTP protocol is used

6.Ensure that end point is included so that can be called by other systems

7.Validate the request body before processing the request. If the request is JSON, validate the json structure and data using JSON schema validator

8.Ensure to maintain the proper API specification(Eg:API spec can be defined in Swagger)

9.It is recommended to create a service account for each system that will be interacting with Web APIs.

10.It is no longer recommended to publish process models as a web service. Instead use a Web API with a! start Process to start a process from an external system.