It may just be me, but this increased working from home has amplified my desire to connect. Recently, we held the SmartBear Connect 2020, our virtual user conference. If the attendance and positive feedback are any measure, a lot of people are interested in making connections, even if all we can do nowadays is virtual.
As a product marketing person on the SmartBear API products, I was involved in our session development supporting API development. I attended several sessions, and one of the ones I can recommend to the people interested in API design is the SwaggerHub session by Tim Maguire, Director of Product Management. The title of this session is What’s New in SwaggerHub and I wanted to share with you a short overview of what’s in store. I really liked the mix of brief slides and demos to reinforce. In case you prefer to watch the demos, I have added counter times throughout this blog.
The presentation begins with a look at the areas of focus that have more recently guided SwaggerHub development and continue into 2020. These development areas are:
- Developer Experience
- Integration and Automation
- Governance and Standards
In the first area, Developer Experience, we learn about new enhancements that have been added to SwaggerHub. One of those involves support for OAS3.0 for Domains. For those of you that are new to SwaggerHub, a domain is a library of common components (parameters, responses, data models) within the product that can be reused across multiple API definitions. The net effect is to accelerate development and make you more productive.
Next up under Developer Experience is an enhancement to the SwaggerHub documentation to support multiple examples. You can specify examples for objects, individual properties and operation parameters in order to make your OpenAPI Specification clearer to the tools and libraries that process your API in some way.
The last item covered in Developer Experience involves the SwaggerHub Visual Editor. We have added new enhancements that make it easier for the technical writer or business analyst to interact with the API.
The session then shifts into demo mode, (@ 4:17 if want to jump ahead) which really illuminates the new changes for Developer Experience, especially during the section on the Visual Editor. I really liked how simple it is for adding descriptions in the Visual Editor, and how Tim shows the continuity between jumping from the Visual Editor and Code Editor.
The next section of the presentation focuses on SwaggerHub features for Integration and Automation. There are four enhancements within SwaggerHub that are called out, specifically Registry API updates, Git integrations, Auto import, and versioning for Git integrations.
If you are new to SwaggerHub, the Registry API is an API provided by SwaggerHub that lets you search, retrieve, create and update OpenAPI definitions in the SwaggerHub registry. New enhancements to the Registry API enable you to publish and unpublish an API, and the ability to set an API default version, both of which can be very useful when creating integrations with your CI/CD pipeline.
There are several enhancements called out in the session around SwaggerHub support for integrations with Git-based repositories other source control management tools. For instance, there is the ability to auto-import API definitions from Git into SwaggerHub. Last, but not least is our new support for API versioning with Git. When you create a new version of an API in SwaggerHub, we will automatically create a new version in GitHub. To illustrate these new enhancements to SwaggerHub around integrations and versioning, Tim takes us through a demo (@14:16).
The next area of SwaggerHub enhancements covered in this presentation involves Governance and Standards. New capabilities in this area include Single-Sign On (SSO) support, Custom Docs branding, API project enhancements and API standardization.
Ensuring API security is a growing challenge within organizations. To address that need, we have added SSO support for our SwaggerHub SaaS product. This new capability is based on SAML and supports the major SAML SSO providers, such as Active Directory, AuthO, Okta, OneLogin, Ping, etc.
Another enhancement within this area is the ability to customize documentation. While this might not jump out as critical, many customers have asked for the ability to make their API documentation brand compliant using specific colors and adding logos.
API Projects in SwaggerHub help organization owners arrange APIs and domains logically and manage their visibility to other members of the development team. We have introduced new enhancements to our Projects workflow, making it easier to add APIs into projects as well as making it easier to move APIs between Projects.
API Standardization can play an important role in reinforcing governance in your design process. To speed development while maintaining quality, many organizations are using API style guides. SwaggerHub already has embedded rules that check operations, parameters, etc. New to the product are custom rules that now enables organizations to write their own custom rules for API standardization with their industry-specific style guides.
To really bring home the new enhancements in the Governance and Standards focus area, Tim then takes us through a demo of the key features (@22:50). There is nothing like seeing the tool in action, so take a minute to linger on this demo.
Once you get the bug for API design it is hard to stop. You can get started immediately with SwaggerHub by clicking here for a free trial.
So, while you are out there working anonymously from your upstairs bedroom, or kitchen, or for the lucky official home office, know that you are not alone, and that SmartBear is connected to you. We support multiple open source communities like Swagger, SOAPUI and Cucumber. We offer a ton of videos and training materials, most of which are free. Also, I barely scratch the surface of SmartBear Connect 2020, so if you are interested in more expert and customer sessions, check out the On-Demand link.