Skip to main content
Category

Blog

JOIN US AT ASC 2022! 

By Announcement, Blog, Events

The API Specification Conference – ASC 2022 – is being held in person from September 19 – 21 in South San Francisco! OpenAPI Initiative’s API Specifications Conference (ASC) is a place for API practitioners and enthusiasts to come together and discuss the evolution of API technologies. The OpenAPI Specification, RAML, Blueprint, gRPC, OData, JSON Schema, GraphQL, AsyncAPI, and other formats will all be topics, enabling attendees to get familiar with these formats and discuss how to use them in practice.

ASC includes cutting-edge technology keynotes and sessions that chart the future of APIs with in-depth specification and standards discussions. This year’s first announced keynote is presented by Jean Yang, CEO of Akita Software. Jean is the founder and CEO of Akita Software, a developer tools company building “one-click” observability. Previously, Jean was a professor of Computer Science at Carnegie Mellon University. She has a Ph.D. from MIT, holds software tools patents from work at Microsoft Research and Facebook, and was selected as one of the MIT Technology Review’s 35 Innovators Under 35 in 2016.

The event is designed to be highly interactive with plenty of discussion time throughout the workshops and sessions!

The lineup of early bird talks is also being announced and includes presentations from: 

  • Erez Yalon, Checkmarx, Evolution of the API Security Top 10
  • Jeremy Glassenberg, Docusign, Setting Standards and Create Smooth API Implementations
  • Brian Terlson, Microsoft, Developing API-First Multi-Protocol Services with Cadl 
  • Ben Hutton, Postman/JSON Schema, JSON Schema in Production
  • Shai Sachs, Wayfair, Specs are Important, Trust is Mandatory

You won’t want to miss it! Learn more and register to attend.

APIIDA, Delivering Automated API Management Solutions, Joins the OpenAPI Initiative

By Blog

The OpenAPI Initiative, the consortium of forward-looking industry experts focused on evolving and implementing the OpenAPI Specification (OAS), is welcoming APIIDA as a new member.

APIIDA provides an API management platform and develops solutions and products for customers to manage change by enabling technology-independent API management. The APIIDA solution separates APIs from their runtimes and adapts them to focused strategies, acting as independent entities. This is done with the goal to improve customer experience and allow the rapid growth of new business models and offerings. 

“We are excited to be a part of the OpenAPI Initiative. Having widely adopted standards like OpenAPI provides us with a stable base we can build upon. Together with the other members of the OpenAPI Initiative, we want to expand the reach and the adoption of the OpenAPI Specification. This will benefit APIIDA customers, and it’s the right thing to do for the broader API community,” said Markus Müller, CTO, and co-founder of APIIDA. “By actively contributing to the special interest groups and the steering committees we want to give back to the community.”

The company currently serves over 300 organizations of all sizes and across a wide range of industries. 

Want to become a member of the OpenAPI Initiative? Find more information here!

APIIDA Resources:

OpenAPI Resources

To learn more about participating in the evolution of the OpenAPI Specification: 

https://www.openapis.org/participate/how-to-contribute

About the OpenAPI Initiative

The OpenAPI Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing how APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving, and promoting a vendor-neutral description format. The OpenAPI Specification was originally based on the Swagger Specification, donated by SmartBear Software. To get involved with the OpenAPI Initiative, please visit https://www.openapis.org

About Linux Foundation

Founded in 2000, the Linux Foundation is supported by more than 1,000 members and is the world’s leading home for collaboration on open-source software, open standards, open data, and open hardware. Linux Foundation projects like Linux, Kubernetes, Node.js, and more are considered critical to the development of the world’s most important infrastructure. Its development methodology leverages established best practices and addresses the needs of contributors, users, and solution providers to create sustainable models for open collaboration. For more information, please visit us at linuxfoundation.org.

Karate Labs, Testing Automation Framework, is Joining the OpenAPI Initiative

By Blog

The OpenAPI Initiative, the consortium of forward-looking industry experts focused on evolving and implementing the OpenAPI Specification (OAS), is announcing that Karate Labs has joined as a new member.

5900 GitHub stars | Used by Fortune 500 companies worldwide 

Karate Labs is an open-source solution unifying API & UI test automation including mock-servers and performance testing. Karate’s core of API testing includes sophisticated payload data and schema validation, and a unique capability to re-use API tests as performance tests.

Karate Labs API data importer enables teams to import all leading sources of API data and to preview, edit and export the API sequence using an intuitive no-code user experience.

“With more teams adopting the OpenAPI Specification as a standard, we see the opportunity to align test automation efforts and further accelerate adoption. We are excited to join the OpenAPI Initiative to deliver even more value to our customers,” said Kapil Bakshi, co-founder, and CEO of Karate Labs. “With software products depending more than ever on APIs, the OpenAPI specification has injected more rigor and collaboration into how APIs are designed, implemented, and consumed. Karate Labs aims to simplify test automation for business stakeholders, product owners, and QA specialists.” 

OpenAPI Initiative is always welcoming NEW MEMBERS, find more information about becoming an OpenAPI member here!

Karate Labs Resources:

OpenAPI Resources

To learn more about participating in the evolution of the OpenAPI Specification: https://www.openapis.org/participate/how-to-contribute

About the OpenAPI Initiative

The OpenAPI Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving, and promoting a vendor-neutral description format. The OpenAPI Specification was originally based on the Swagger Specification, donated by SmartBear Software. To get involved with the OpenAPI Initiative, please visit https://www.openapis.org

About Linux Foundation

Founded in 2000, the Linux Foundation is supported by more than 1,000 members and is the world’s leading home for collaboration on open-source software, open standards, open data, and open hardware. Linux Foundation projects like Linux, Kubernetes, Node.js and more are considered critical to the development of the world’s most important infrastructure. Its development methodology leverages established best practices and addresses the needs of contributors, users, and solution providers to create sustainable models for open collaboration. For more information, please visit us at linuxfoundation.org.

OpenAPI v3.1 Resources for Tooling Developers 

By Blog

This post is authored by Phil Sturgeon, Green Tech consultant at Green Turtle, and Chairperson, Protect Earth. If you’d like to donate to Phil’s charity of choice, please see Protect Earth which is reforesting the U.K. one field at a time.

OpenAPI v3.1.0 has a bunch of great changes, solving problems like the subtle differences between JSON Schema objects and OpenAPI Schema objects, and adds support for Webhooks.

Upgrading tooling can be tricky, but this should be a lot easier than the jump from v2 to v3.0. To reduce the workload we’ve put together some convenient resources for tooling developers, to provide test cases, examples, and guidance in general.

First of all, these articles will show the differences between v3.0 and v3.1 from a user perspective:

Do you need to support everything?

Some of that content is aimed more at end users and what they will need to do, but what do tooling vendors need to do?

For new features like webhooks, you can think to yourself: does this tool need to support webhooks? If it’s a documentation tool, probably! If the tool is validating incoming web requests to your server, then probably not.

Some tools have gone with a definition of 3.1.0 support which is “a 3.1.0 document will work equally well as a 3.0.0 does in the same tool”, which is a good first step. Then support for other new keywords can be added later.

It’s my opinion that getting 3.1.0 documents to work at a basic level is more important than supporting every single feature in 3.1.0. End-users will create feature requests for the bits they’re most excited about as you go.

JSON Schema consolidation

For the bulk of the other changes, the difference is that instead of using a schema object that is very similar to JSON Schema, the OpenAPI Schema object is now literally JSON Schema. There’s some technicalities involved here and technically OpenAPI Schema has defined it’s own JSON Schema vocabulary, which extends the main JSON Schema vocabulary and adds support for discriminator. As the usage of discriminator in 3.1.0 was clarified to be purely a “hint” or shortcut for an existing oneOf, anyOf, allOf, this can be safely ignored by the vast majority of tooling.

tl;dr: you can use any valid JSON Schema tooling to work with the contents of a schema: object in OpenAPI, which means a lot of tools can phase out reliance on hand-crafted schema inspection code, and leverage any of the existing JSON Schema tooling instead.

For example, if a tool you maintain was manually validating OpenAPI Schemas in JavaScript before, it might be an idea to wrap that in an if ($version == "3.0") statement, use that old logic, deprecate it, then if the version is 3.1 you could leverage powerful tools like AJV or HyperJump to do all the heavy lifting. This immediately benefits your tooling from them doing all the work supporting modern JSON Schema / OAS3.1 keywords for you, like if/then/else.

It also means they can do the heavy lifting for other changes that come as JSON Schema matures into a stable release (although it would be brilliant if you could help them out a too).

Test Cases

To make sure your tooling works with OpenAPI v3.1, you’ll need some OpenAPI v3.1 documents to test against. There is no official list of OpenAPI v3.1 documents around, but there are some example files written by the community which can be used in a test suite to show pass or fail scenarios:

Validation Schema

Many tools use a JSON Schema document that describes valid OpenAPI documents. Yes that is a very meta sentence, but if you know what I mean then you are wondering if there is a new one for OpenAPI v3.1? Good news, there is!

Find Other v3.1 Tooling

To see how other OpenAPI tools are doing take a look at OpenAPI.Tools. Perhaps there is some other tooling you could leverage, or some developers you could team up with, or ask questions to, or hire to work on your thing too, etc.

Don’t forget to send a pull request to OpenAPI.Tools to say when you’re supporting v3.1, by adding v3_1: true to _data/tools.yml. You can also pop a openapi31 tag on GitHub so that other tooling aggregators can find you too!

Expand allBack to topGo to bottom

OpenAPI Welcomes New Member Optic

By Blog

The OpenAPI Initiative, the consortium of forward-looking industry experts focused on evolving and implementing the OpenAPI Specifications (OAS), is welcoming Optic as a new member!

Optic’s open source tools help make the OpenAPI Specification and API-first practices adoptable. Keeping up-to-date OpenAPI descriptions is an important part of any API-first workflow and Optic’s tools are intended to make it easy for every developer to work with OpenAPI without having to write it manually. 

“Optic has been one of the most popular open source tools for maintaining accurate API docs. We always had our own spec under the hood, but some of our largest customers and most influential community members started a project to adopt OpenAPI,” said Aidan Cunniffe, CEO and Founder, Optic. “Coming home to OpenAPI has been really great, and we’re excited to take all the learnings and use them to make OpenAPI more adoptable for teams.”

Once teams are planning and tracking their API changes in OpenAPI, they are well on their way to working API-first. Optic’s API Review tool (in beta) can plug into Pull Requests and CI and shows Code Reviewers the API changes under consideration and their impact. Teams can set up CI to test API changes against their company’s API guidelines. This helps developers think about the impact of problematic changes before they get deployed to consumers. 

Optic Resources

OpenAPI Resources

To learn more about participate in the evolution of the OpenAPI Specification: https://www.openapis.org/participate/how-to-contribute

About the OpenAPI Initiative

The OpenAPI Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving, and promoting a vendor neutral description format. The OpenAPI Specification was originally based on the Swagger Specification, donated by SmartBear Software. To get involved with the OpenAPI Initiative, please visit https://www.openapis.org

About Linux Foundation

Founded in 2000, the Linux Foundation is supported by more than 1,000 members and is the world’s leading home for collaboration on open-source software, open standards, open data, and open hardware. Linux Foundation projects like Linux, Kubernetes, Node.js and more are considered critical to the development of the world’s most important infrastructure. Its development methodology leverages established best practices and addresses the needs of contributors, users, and solution providers to create sustainable models for open collaboration. For more information, please visit us at linuxfoundation.org.

Announcing the API Specifications Conference (ASC) 2022 Early Bird Submission Deadline

By Blog

The fourth API Specifications Conference (ASC) will take place from September 19th through September 21st. We’re delighted to be back in-person this year after two years of having a virtual-only event! As part of the call for proposals we’re accepting and announcing five talks early. To have your talk considered, please have your submission completed by May 6th , 11:59 PM PDT.

The early bird submission will give you advance notice to prepare for your talk and your talk will be announced before the full schedule, giving you an opportunity to amplify your topic. Additionally, this year we are giving early birds the flexibility to choose which day they would like to speak.

Submit your talk today!

Early bird deadline: May 6th , 11:59 PM PDT

Regular deadline: May 27th , 11:59 PM PDTNew deadline – June 3rd, 11:59 PM PDT

We will notify any speakers who have an early bird submission accepted within two weeks after the deadline. Even if your early bird submission is not accepted in this round, it will still be reviewed along with other entries after the regular deadline.

If you need help or advice for your submissions, please contact speakers@openapis.org. If you are a first-time and/or underrepresented speaker, we especially want to help you submit a talk and are available to help you work through talk ideas or how to structure your proposal.

On behalf of the organizing committee,

Frank Kilcommins, Program Chair, ASC 2022

API Specifications Conference (ASC) 2022 – Call for Proposals

By Blog

After a fantastic inaugural event in 2019, successful virtual events in 2020 and 2021, the API Specifications Conference (ASC) is back in-person in 2022, from September 19th through September 21st. Mark your calendars!

ASC 2022 will include keynotes, sessions, panel talks and open discussion on specifications and standards behind the cutting-edge technologies that chart the future of APIs. And we want to hear your talk proposals!

We are looking for talks that range from beginner-level introductions to API specifications all the way through expert recommended practices and forward-looking sessions on API specifications and standards. The OpenAPI Specification, gRPC, AsyncAPI, GraphQL, RAML, API Blueprint, ODATA, JSON Schema, and other formats, all make for great topics at this event. We want to hear your talks on how you are using specifications and standards in practice. Topics can include but are not limited to design, testing, security, lifecycle, runtime, governance, and developer experience. In-depth discussions not only enable attendees to get familiar with these specifications and standards but use them in practice.

API practitioners and enthusiasts involved across the full spectrum of API lifecycle activities will attend ASC 2022. We’re looking for API designers, API developers, API testers, API technical writers, API product managers, API security, API Operations, enterprise architects, and many more personas to actively participate. We encourage and welcome you to make submissions.

Check out last year’s talks to get an idea of the different kinds of talks we have had: https://www.youtube.com/playlist?list=PLcx_iGeB-Nxi54fIfinPnGfn6lPOLnLXQ

The Call for Proposals is open:

Submit your talk at: https://sessionize.com/api-specifications-conference-2022/

Submission deadline: May 27th , 11:59 PM PDTNew deadline – June 3rd, 11:59 PM PDT

If you need help or advice for your submissions, please contact speakers@openapis.org. If you are a first-time and/or underrepresented speaker, we especially want to help you submit a talk and are available to help you work through talk ideas or how to structure your proposal.

We’re looking forward to your proposals and participation that will make ASC 2022 a great event again this year!

On behalf of the organizing committee,

Frank Kilcommins, Program Chair, ASC 2022

Flotiq, API-First Content Management Platform, Joins OpenAPI Initiative

By Blog

The OpenAPI Initiative, the consortium of forward-looking industry experts focused on evolving and implementing the OpenAPI Specification (OAS), is announcing that Flotiq has joined as a new member.

Flotiq is a content management platform that is focused on APIs. It enables users to create custom content types. It generates supporting APIs, documentation, SDKs, and Postman collections. The Content Types created in Flotiq are automatically translated into a set of RESTful endpoints. Flotiq provides an OpenAPI schema that updates automatically after every change made to data models. That schema is then used for generating SDKs and API docs. Tapping into the OpenAPI ecosystem – Flotiq takes the developer experience to the next level and facilitates system intregration and publishing content through standard-compliant APIs.

“At Flotiq we strongly believe in open standards to enable development of well-engineered systems. We support the OpenAPI Specification extensively in our product, and by joining the OpenAPI Initiative we see a real opportunity to help shape the future of OpenAPI,” said Andrew Wytyczak-Partyka, CEO, Flotiq. “Now, more than ever, it’s time for us to engage with the community. We’re excited to be a member of the OpenAPI Initiative.”

Flotiq Resources

OpenAPI Resources

To learn more about participate in the evolution of the OpenAPI Specification: https://www.openapis.org/participate/how-to-contribute

About the OpenAPI Initiative

The OpenAPI Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving, and promoting a vendor neutral description format. The OpenAPI Specification was originally based on the Swagger Specification, donated by SmartBear Software. To get involved with the OpenAPI Initiative, please visit https://www.openapis.org

About Linux Foundation

Founded in 2000, the Linux Foundation is supported by more than 1,000 members and is the world’s leading home for collaboration on open-source software, open standards, open data, and open hardware. Linux Foundation projects like Linux, Kubernetes, Node.js and more are considered critical to the development of the world’s most important infrastructure. Its development methodology leverages established best practices and addresses the needs of contributors, users, and solution providers to create sustainable models for open collaboration. For more information, please visit us at linuxfoundation.org.

Treblle, API Monitoring and Analytics, Is OpenAPI’s Newest Member

By Blog

The OpenAPI Initiative, the consortium of forward-looking industry experts focused on evolving and implementing the OpenAPI Specification (OAS), is announcing today that Treblle has joined as a new member. 

Treblle provides API monitoring and analytics solutions, and makes it “easy to understand what’s going on with your APIs and the apps that use them.” Treblle was established to solve problems the founders themselves, Vedran Cindrić and Darko Blaževic, had experienced. 

Based in Zagreb, Croatia, Treblle announced €1.2 million in via Nauta Capital in July 2021. 

“I wanted Treblle to join the OpenAPI specification because I strongly believe that we need to have some kind of standard, guide or north star when it comes to API docs,” said Vedran Cindrić, Founder, Treblle. “I’ve spent the past 10 years building products, platforms, apps and APIs. I saw some amazing APIs with superb documentation, but I also saw a lot of terrible APIs that were documented horribly. I think the OpenAPI specification is a great way of pushing documentation forward and, more importantly, pushing developers forward to not just write docs but build better APIs.”

Full Treblle API Monitoring and Analytics information available here: https://treblle.com/ 

More from Treblle

Free Treblle ebook for building great REST APIs: https://treblle.com/ebooks/the-10-rest-commandments 

Treblle for PHP, Python, Node, Laraval and more: https://github.com/Treblle 

Treblle on Reddit: https://www.reddit.com/r/DevelopingAPIs/ 

OpenAPI Resources

To learn more about participate in the evolution of the OpenAPI Specification: https://www.openapis.org/participate/how-to-contribute

About the OpenAPI Initiative

The OpenAPI Initiative (OAI) was created by a consortium of forward-looking industry experts who recognize the immense value of standardizing on how APIs are described. As an open governance structure under the Linux Foundation, the OAI is focused on creating, evolving and promoting a vendor neutral description format. The OpenAPI Specification was originally based on the Swagger Specification, donated by SmartBear Software. To get involved with the OpenAPI Initiative, please visit https://www.openapis.org

About Linux Foundation

Founded in 2000, the Linux Foundation is supported by more than 1,000 members and is the world’s leading home for collaboration on open source software, open standards, open data, and open hardware. Linux Foundation projects like Linux, Kubernetes, Node.js and more are considered critical to the development of the world’s most important infrastructure. Its development methodology leverages established best practices and addresses the needs of contributors, users and solution providers to create sustainable models for open collaboration. For more information, please visit us at linuxfoundation.org.

This Year’s API Specification Conference (ASC 2021) by the Numbers

By Blog

This year’s API Specifications Conference (ASC) organized by the OpenAPI initiative was held virtually from September 28 through 29, 2021. The conference continues to grow by leaps and bounds and is gaining the attention of people interested in API technology. It was a real thrill hearing from industry experts discussing topics such as OpenAPI Specifications, RAML, Blueprint, gRPC, OData, JSON, Schema, GraphQL, AsyncAPI and other formats. For example, the keynote presentation Leading API efforts at scale by Mandy Whaley & Yina Arenas, Microsoft, So you think you understand JSON Schema? By Ben Hutton, Postman/JSON Schema. Or AsyncAPI 2.0: Enabling the Event-Driven World by Someshekhar Banerjee, Ebay.The discussions helped attendees get acquainted with the different formats and also learn how to practically use them.

The full Linux Foundation report on ASC 2021, “Transparency Report: API Specifications Conference (ASC) 2021” is available now (PDF).

We had attendance from 319 people from 37 countries—with a majority of them attending up to 10 sessions. 

The survey conducted after the conference showed that 89% of the attendees rated the content delivered at the conference as “Great” or “Excellent.”

The charge for the entire conference was $39 and 10 community scholarships were given to active members of the open source community. OpenAPI donated $10 from each registration fee and a total of $2,500 was donated to Code2040 in support of their mission. Code2040 is growing racial equity lens in the tech industry through their Fellows Program with technology companies. The conference received a Gold badge with the highest rating from the CHAOSS D&I Event Badging Program, showing that we promote healthy D&I practices.

Online events have created an opportunity for us to reach new audiences and expand our reach. For those that missed the conference or would like to watch the event again, the keynote and session recordings are available on our YouTube Channel. Speaker presentations are also available for download under each talk here.

 

Download the full Linux Foundation report on ASC 2021, “Transparency Report: API Specifications Conference (ASC) 2021” (PDF).