Compliance Validation for Designed APIs Vadim Klimov SAP Integration Architect SAP Inside Track Copenhagen November 12, 2022 

API Lifecycle Management Approaches Shift left Move tasks earlier in the API development process. The approach promotes a contract-first principle to API design and encourages automation of API governance (including early validation of API compliance with style guides, established standards and best practices). Shield right Put controls in place that protect the deployed APIs. The approach emphasises advanced API discovery, observability and protection, proactive scanning, and API drift detection. 

API Contract Validations API design security guidelines Traditional API style guide ▪ API lifecycle management guidelines ▪ Naming conventions ▪ Versioning ▪ Design patterns ▪ Performance optimisation patterns ▪ Data formats ▪ Error formats ▪ Transport and communication protocols ▪ Authentication and authorisation mechanisms ▪ Request data validation ▪ Response data protection ▪ Excessive data exposure prevention ▪ Activity logging 

API Contract Validation Automation: Components API contract Linter Ruleset An API contract is represented using a YAML or JSON format and ▪ For REST APIs – is compliant with the OpenAPI standard, ▪ For event-driven APIs - is compliant with the AsyncAPI standard. A static analysis tool that can validate the API contract against the specified ruleset. ▪ Examples of OpenAPI linters: Spectral, Redocly, Zally, IBM OpenAPI Validator. ▪ Examples of API security platforms: 42Crunch, Salt Security. A set of rules that must be applied to an API contract. Commonly rules originate from and are based on a style guide, design guidelines, best practices, etc. ▪ Examples of API style guides and design guidelines: http://apistylebook.com. ▪ API design security guidelines, among other things, commonly include recommendations for the mitigation of OWASP API Security Top 10 security risks (https://owasp.org/www- project-api-security). 

API Contract Linter: Key Features and Capabilities Extensibility Enhance and extend out-of-the-box functionality with 3rd party or custom plugins/extensions, develop custom validation functions. Validation executions history and evolution analysis Evolution analysis and retrospective view on validation/compliance issues that have been detected in the API contract, API compliance trend analysis. Validation results output and formatting Output validation results using formats that are convenient for human-readable and machine- readable processing. Integration with CI/CD tools For example, integration with Azure Pipelines, GitLab, CircleCI, Jenkins, TeamCity. Integration with code quality assurance tools For example, integration with SonarQube. Integration with code editors and IDEs For example, integration with Visual Studio Code, IntelliJ, Eclipse. 

Demo 

No content