Top Related Projects
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
Swagger Editor
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
Quick Overview
Apicurio Studio is an open-source API design studio that allows users to create, edit, and manage OpenAPI and AsyncAPI definitions. It provides a web-based interface for designing APIs, collaborating with team members, and generating documentation and code artifacts from API designs.
Pros
- User-friendly graphical interface for API design
- Supports both OpenAPI (REST) and AsyncAPI (event-driven) specifications
- Collaborative features for team-based API development
- Integration with version control systems like Git
Cons
- Limited customization options compared to some commercial API design tools
- Requires setup and maintenance of a server infrastructure
- Learning curve for users new to API design concepts
- Some advanced features may require additional configuration or plugins
Getting Started
To get started with Apicurio Studio, follow these steps:
-
Clone the repository:
git clone https://github.com/Apicurio/apicurio-studio.git
-
Navigate to the project directory:
cd apicurio-studio
-
Build the project using Maven:
mvn clean install
-
Run the application:
java -jar platforms/quarkus/target/apicurio-studio-quarkus-runner.jar
-
Open a web browser and navigate to
http://localhost:8080
to access the Apicurio Studio interface.
For more detailed instructions and configuration options, refer to the project's documentation in the repository.
Competitor Comparisons
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
Pros of openapi-generator
- Supports a wider range of programming languages and frameworks
- More extensive customization options for code generation
- Larger community and more frequent updates
Cons of openapi-generator
- Steeper learning curve due to its extensive features
- Can be more complex to set up and configure for specific use cases
- May generate more boilerplate code in some scenarios
Code Comparison
apicurio-studio:
@Path("/designs")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public interface DesignsResource {
@GET
public Collection<Design> listDesigns();
}
openapi-generator:
@Path("/pets")
@Produces({"application/json", "application/xml"})
public interface PetApi {
@GET
@Produces({"application/json", "application/xml"})
public Response listPets(@QueryParam("limit") Integer limit);
}
Both examples show generated API interfaces, but openapi-generator provides more detailed annotations and supports multiple content types. apicurio-studio's output is more concise, focusing on JSON only in this case.
Swagger Editor
Pros of Swagger Editor
- More established and widely adopted in the API development community
- Offers a simpler, lightweight interface for quick edits and prototyping
- Provides real-time visual feedback with a split-screen view
Cons of Swagger Editor
- Limited collaboration features compared to Apicurio Studio
- Lacks advanced version control and project management capabilities
- Does not offer as comprehensive API design governance features
Code Comparison
Swagger Editor (YAML):
openapi: 3.0.0
info:
title: Sample API
version: 1.0.0
paths:
/users:
Apicurio Studio (JSON):
{
"openapi": "3.0.0",
"info": {
"title": "Sample API",
"version": "1.0.0"
},
"paths": {
"/users": {}
}
}
Both tools support OpenAPI (formerly Swagger) specifications, with Swagger Editor primarily using YAML and Apicurio Studio offering both YAML and JSON formats. Apicurio Studio provides a more comprehensive API design platform with additional features for team collaboration, version control, and API governance. Swagger Editor, on the other hand, offers a simpler, browser-based editor for quick API specification editing and visualization.
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
Pros of Postman App Support
- Extensive user community and support network
- Regular updates and feature enhancements
- Comprehensive documentation and learning resources
Cons of Postman App Support
- Limited open-source collaboration opportunities
- Less flexibility for custom modifications
- Potential vendor lock-in for enterprise users
Code Comparison
While a direct code comparison is not particularly relevant for these repositories, we can look at how they handle issue reporting:
Apicurio Studio:
name: Bug Report
description: File a bug report
labels: [bug, triage]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Postman App Support:
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Apicurio Studio uses a structured YAML format for issue templates, while Postman App Support uses a more traditional markdown approach. Both aim to gather detailed information about bugs, but Apicurio's method may lead to more consistent reporting.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
The apicurio-studio project (Open Source API Design Studio)
Summary
This is the official Git repository for the Apicurio Studio project: http://www.apicur.io/studio
The Apicurio Studio project is an API design studio that can be used to create new or edit existing API designs (using specifications like OpenAPI or AsyncAPI).
Get the code
The easiest way to get started with the code is to create your own fork of this repository, and then clone your fork:
$ git clone git@github.com:<you>/apicurio-studio.git
$ cd apicurio-studio
$ git remote add upstream git://github.com/apicurio/apicurio-studio.git
At any time, you can pull changes from the upstream and merge them onto your main:
$ git checkout main # switches to the 'main' branch
$ git pull upstream main # fetches all 'upstream' changes and merges 'upstream/main' onto your 'main' branch
$ git push origin # pushes all the updates to your fork, which should be in-sync with 'upstream'
The general idea is to keep your 'main' branch in-sync with the 'upstream/main'.
Building apicurio-studio
Requirements
- Node.js and NPM
Building
Use standard NPM based UI tooling to build the project:
cd ui
npm install
npm run build
npm run package
Contribute fixes and features
Apicurio Studio is open source, and we welcome anybody who wants to participate and contribute!
If you want to fix a bug or make any changes, please log an issue in GitHub describing the bug or new feature. Then we highly recommend making the changes on a topic branch named with the GitHub issue number. For example, this command creates a branch for an issue with number 1234:
$ git checkout -b apicurio-studio-1234
After you're happy with your changes and a full build (with unit tests) runs successfully, commit your changes on your topic branch. Then it's time to check for and pull any recent changes that were made in the official repository:
$ git checkout main # switches to the 'main' branch
$ git pull upstream main # fetches all 'upstream' changes and merges 'upstream/main' onto your 'main' branch
$ git checkout apicurio-studio-1234 # switches to your topic branch
$ git rebase main # reapplies your changes on top of the latest in main
# (i.e., the latest from main will be the new base for your changes)
If the pull grabbed a lot of changes, you should rerun your build to make sure your changes are still good.
You can then either create patches (one file per commit, saved in ~/apicurio-studio-1234
) with
$ git format-patch -M -o ~/apicurio-studio-1234 orgin/main
and upload them to the JIRA issue, or you can push your topic branch and its changes into your public fork repository
$ git push origin apicurio-studio-1234 # pushes your topic branch into your public fork of apicurio-studio
and generate a pull-request for your changes.
We prefer pull-requests, because we can review the proposed changes, comment on them, discuss them with you, and likely merge the changes right into the official repository.
Please try to create one commit per feature or fix, generally the easiest way to do this is via git squash. This makes reverting changes easier, and avoids needlessly polluting the repository history with checkpoint commits.
Code Formatting
When you are hacking on some apicurio-studio code, we'd really appreciate it if you followed the
apicurio-studio coding standards. The project uses eslint
to ensure these standards. You can
check your code using:
cd ui
npm run lint
Top Related Projects
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
Swagger Editor
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot