Seeing “Let’s Go!” in massive letters, because the theme for Cisco Live US, jogs my memory of the soccer announcer’s “Gooooooooooaaaaaaaallllllllll” cry. This reminder excites me for the remainder of Ted Lasso’s season 3. My thoughts makes these connections for soccer, er, soccer, and Cisco Live.
Like the most effective examples of coaches are those with the most effective win/loss report, the identical goes for Cisco APIs. And typically, the most effective coaches search for steady enchancment somewhat than successful in any respect prices. We proceed to work with engineering groups to enhance Cisco APIs over time, and our teaching has yielded some wonderful examples, which you’ll study at Cisco Live US in June 2023.
Learn what Cisco has been as much as in API design and implementation
You could have seen the Cisco API-first announcement beginning with backward compatibility for seven flagship Cisco APIs in November 2022. You will be capable of see the instrument that helps detect backward compatibility by getting a demo of API Insights within the DevNet Zone. The API Insights demo exhibits how we are able to evaluate two OpenAPI paperwork. Cisco joined the OpenAPI initiative in mid-2022. By evaluating the adjustments in OpenAPI paperwork throughout releases, groups can generate changelogs for APIs and monitor adjustments over time. We share a preview of the brand new API Insights model used internally, which will probably be up to date as open supply in summer season 2023. This preview exhibits automation skills for producing changelogs and figuring out undesirable breaking adjustments. After dealing with massive OpenAPI paperwork with a whole lot of 1000’s, even hundreds of thousands of traces, we are able to present you our findings. You need to cease by and see this demo. And we need to hear your API design questions.
Improving your developer expertise
We additionally need to know your expertise with API documentation at developer.cisco.com. Please go to the Design Thinking Area of the DevNet Zone, share your expertise, uncover the current adjustments within the developer portal, and supply suggestions on future developments. Designers are there all week to study out of your experiences. Please cease by, full our survey, and undergo a well-honed design considering expertise.
Inclusive language in API design
We imagine within the energy of phrases at Cisco and have included testing for our inclusive language coverage inside our API Insights instrument. When biased phrases equivalent to grasp, slave, blacklist, or whitelist are detected in an OpenAPI doc, the API Insights toolset notifies and lists recommended options.
We just lately investigated deal with biased language in a launched API. We got here up with three potential approaches:
- The “New only” method makes use of the inclusive time period just for the brand new creation of an object. Think of the primary/grasp default department title change that GitHub carried out as a great instance.
- The “Rip off the Band-Aid” method for JSON payloads returned from an API, for instance. Inform builders that relying on the present API model, it’ll return masterDevice/slaveDevices, and within the subsequent model, it’ll return controlDevice/dataDevices.
- The “Alias” method for the API design permits each phrases to work for a chosen period of time and replace the API documentation to advertise the newer method. For instance, this method may work for biased phrases in endpoint paths. You need to give some planning and time to maneuver to the inclusive time period.
If you have an interest in such design discussions, please cease by the API Quality Demo pod within the DevNet Zone and share your learnings and greatest practices.
Sign up for API-first, API high quality, and API safety classes
Interested in hands-on workshops? Get into the tooling with these classes:
Want to find and study from others? Go to those classes:
- API first in a CLI world, how to consider API first – DEVNET-1050
Anne Gentle, Leader, Global Developer Experience
Ray Stephenson, Sr Director, Head of Developer Relations - Extending Experiences with APIs – INTAPP-1300, Thursday, Jun 8, 11:30 – 12:15 PDT
Dexter Park, Lead Application Developer, Starbucks
Ray Stephenson, Sr Director, Head of Developer Relations, Cisco Systems, Inc.
Austin Lin, VP Product Management, Cisco Systems, Inc.
For a deeper dive into business greatest practices, don’t miss these classes:
In the meantime, study from these developer assets
If you can not be part of Cisco Live in individual, please verify the every day DevNet readout/takeaways with our stay broadcast.
Also, each session (besides workshops) will go to Cisco Live on-demand in a number of weeks.
You can at all times expertise interactive documentation on developer.cisco.com/learning and take a look at our Learning Labs or reserve a Sandbox to check out Cisco programmable expertise totally free.
We’d love to listen to what you suppose.
Ask a query or depart a remark under.
And keep related with Cisco DevNet on social!
LinkedIn | Twitter @CiscoDevNet | Facebook | YouTube Channel
Share: