Skip to main content
Home

SEGAS Compliance

Explicitly stated expectations for engineering teams

SEGAS-00015 - Designing and Maintaining an API

More information about SEGAS-00015
More information can be found on the engineering website about SEGAS-00015

Does this codebase pass the following requirement: You MUST include a form of versioning to your API?

More information about You MUST include a form of versioning to your API
More information can be found on the engineering website about You MUST include a form of versioning to your API

Does this codebase pass the following requirement: You MUST return appropriate status codes from each endpoint?

More information about You MUST return appropriate status codes from each endpoint
More information can be found on the engineering website about You MUST return appropriate status codes from each endpoint

Does this codebase pass the following requirement: You MUST use appropriate nouns for resource names?

More information about You MUST use appropriate nouns for resource names
More information can be found on the engineering website about You MUST use appropriate nouns for resource names

Does this codebase pass the following requirement: You MUST include some way to observe your API?

More information about You MUST include some way to observe your API
More information can be found on the engineering website about You MUST include some way to observe your API

Does this codebase pass the following requirement: You MUST apply security best practices?

More information about You MUST apply security best practices
More information can be found on the engineering website about You MUST apply security best practices

Does this codebase pass the following requirement: You MUST validate inputs?

More information about You MUST validate inputs
More information can be found on the engineering website about You MUST validate inputs

Does this codebase pass the following requirement: You MUST consider authentication and authorisation?

More information about You MUST consider authentication and authorisation
More information can be found on the engineering website about You MUST consider authentication and authorisation

Does this codebase pass the following requirement: You MUST test your API?

More information about You MUST test your API
More information can be found on the engineering website about You MUST test your API

Does this codebase pass the following requirement: You MUST consider scalability of your API?

More information about You MUST consider scalability of your API
More information can be found on the engineering website about You MUST consider scalability of your API

Does this codebase pass the following requirement: You MUST use an API Specification?

More information about You MUST use an API Specification
More information can be found on the engineering website about You MUST use an API Specification
Continue