Join the #BuildWithBuildAgent Challenge! Get recognized, earn exclusive swag, and inspire the ServiceNow Community with what you can build using Build Agent.  Join the Challenge.

Wasif
Tera Guru
Tera Guru

One of the underrated feature that was introduced in Tokyo release was the export of ServiceNow APIs in the OpenAPI Spec (OAS)! 

  

 

Why this is important? 

* Firstly, it in a way tells, ServiceNow is conforming to the OpenAPI spec for REST 🙂

* Secondly, the OpenAPI spec (either in YAML or JSON) will enable our APIs to be easily ingested into different tools for consumption or documentation

  

Use Cases: 

* Export the OAS files and import into Swagger for centralized documentation- outside ServiceNow application 

* Integrate our APIs with Eqx product engineering frameworks like Developer portal (as initiation starts with the OAS spec file) 

* Help in proper API review by standardizing our practices 

* Ease in onboarding of ServiceNow APIs on API gateways like Apigee (as initiation starts with the OAS spec file) 

 

 

 

https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/task/export-...