Please Share Your OpenAPI Specs So I Can Use Them Across the API Life Cycle
Please do not hide your API definitions. Bring them out of the shadow of your API documentation and give me a link I can click on.
Join the DZone community and get the full member experience.Join For Free
I was profiling the New Relic API, and while I was pleased to find OpenAPI Specs behind their explorer, I was less than pleased to have to reverse engineer their docs to get at their API definitions. It is pretty easy to open up my Google Chrome Developer Tools and grab the URLs for each OpenAPI Spec, but you know what would be easier? If you just provided me a link to them in your documentation!
Your API definitions aren't just driving the API documentation on your website. They are being used across the API life cycle. I am firing up and playing with your API in Postman, generating SDKs using APIMATIC, or creating a development sandbox, so I do not have to develop against your live environment. Please do not hide your API definitions, bring them out of the shadow of your API documentation and give me a link I can click on — one-click access to a machine-readable definition of the value your API delivers.
I'm sure my regular readers are getting sick of hearing about this, but the reality of my readers is that they are a diverse and a busy group of folks and will most likely not read every post on this important subject. If you have read a previous post on this subject from me, and are reading this latest one, and still do not have API definitions or prominent links, then shame on you for not making your API more accessible and usable...because isn't that what this is all about?
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.