The best method of splitting OpenAPIs is to divide them based on functionality or domain. This means grouping related endpoints together, which can make the API easier to understand and maintain. Additionally, consider using versioning to manage changes over time and ensure backward compatibility.

Question

OS

Olivia S.

Network Engineer at ActioNet, Inc.

The best method of splitting OpenAPIs is to divide them based on functionality or domain. This means grouping related endpoints together, which can make the API easier to understand and maintain. Additionally, consider using versioning to manage changes over time and ensure backward compatibility.

Asked about 3 years ago

Open the API documents.

API Development Tools

Comment

1 comment

1

Looks like you’re not logged in.

Users need to be logged in to answer questions

Log In

Daniel W. · Answer 1 · 2022-05-19T15:11:38-05:00

DW

Daniel W.

0

Answered about 3 years ago

There's many ways to separate an Open API specification file, but it all boils down to using `$ref`. You can use `$ref` in certain contexts to refer to other specification files for components or even JSON Schema files. Stoplight Studio can help you manage your refs as well: https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjk0-using-references

The best method of splitting OpenAPIs is to divide them based on functionality or domain. This means grouping related endpoints together, which can make the API easier to understand and maintain. Additionally, consider using versioning to manage changes over time and ensure backward compatibility.

About Stoplight