How Do You Keep Scripted REST API Documentation Up to Date?

[KelleyO]

I'm working with Scripted REST APIs and have been thinking about the maintenance side of API documentation.

Creating the initial documentation isn't usually the difficult part. The problem seems to be keeping it accurate after the API evolves.

For example, a developer might change:

• A request parameter
• A response field
• An authentication requirement
• An endpoint
• An error response

The API itself gets updated, but the documentation can easily be forgotten.

I'm wondering how other ServiceNow teams handle this.

Do you have a process where API changes automatically trigger documentation updates or validation?

[Ankur Bawiskar]

@KelleyO 

I believe it's the responsibility of the team (developer or architect) who update an existing custom Scripted REST API to cater for customer's enhancement

I have been following the same.

💡 If my response helped, please mark it as correct ✅ and close the thread 🔒— this helps future readers find the solution faster! 🙏