Manage your APIs as CIs

[Robert Maxwell]

Managing APIs as Configuration Items (CIs) using Configuration Management principles provides several benefits for organisations relying on software development. A structured approach with a well-defined API catalogue, change management process, version control, and testing and validation ensures proper tracking, management, and integration of APIs, thereby reducing the risk of API-related system failures.

An API catalogue should include all APIs in use, with each having a unique identifier that captures its name, version, and metadata, and continuously updated as the APIs change.

Changes in APIs should be tracked, reviewed, and approved before implementation, with a structured change and release management process that identifies the API being changed, the nature of the change, and its impact on the system.

Version control should capture the version history, including changes made, and the reasons behind them, ensuring that the latest version is always available for use.

APIs should undergo functional, performance, and security testing and validation integrated within a change and/or release management process. Managing APIs as CIs provides:

• greater control and management of software components,
  • CIs are tracked and managed
• improved visibility into software systems
  • CIs are well-defined, documented, and controlled
• effective change management
  • Changes are be tracked, reviewed, and approved before implementation
• improved quality
  • CIs are tested and validated before use and meet security requirements
• stronger risk management
  • By managing APIs as CIs reduce the risk of system failures due to API-related issues
• better governance and compliance
  • CIs leverage well-defined, documented, and controlled processes

Managing APIs as CIs is best practice in software development and provides organisations with a competitive edge. Following Configuration Management principles ensures proper tracking, management, and integration of APIs, resulting in high-quality software systems that meet user and business needs.

Edit:

There's now OOB API CMDB classes 👇

https://www.servicenow.com/community/cmdb-articles/new-data-model-in-cmdb-for-apis/ta-p/2688843

[SteveMacWWT]

Thanks for this Robert!

How do you suggest tracking the CIS, as both objects that get deployed and as objects that are used in Service Mapping?

We are not quite ready to implement the Service Mapping tool, but have the need to track some of them already and want to be ready for implementing it by having them in the right location. 

[Matt Hernandez]

I'm trying to figure out where I should make a Ci for things like scripted REST API, and other integrations. I observe that making them 'Application Models' would allow for selecting them in the 'Product' field on an agile story. So that could help track changes. But I'm not certain if that's really the correct spot in CMDB where these should reside.

[PatriciaP]

Hi Rob,

Interesting article.

My question would be, what ServiceNow CI Class would you use for capturing APIs, or would you suggest this is a custom CI Class?

Thanking you in advance.

Patricia