Skip to content
The modern editor for API Architects and Technical Writers.
Branch: master
Clone or download
rowa97 and philsturgeon Cli publishing (#117)
* Create publish-via-cli.md

* Add files via upload

* Update publish-via-cli.md

* Update publish-via-cli.md
Latest commit 6dab19a Sep 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: link checking (#113) Sep 16, 2019
assets/images Cli publishing (#117) Sep 20, 2019
docs Cli publishing (#117) Sep 20, 2019
templates/tutorial Merge branch 'master' into ross-edits Aug 13, 2019
.gitignore chore: link check in circle Aug 14, 2019
README.md Update README.md (#99) Sep 10, 2019

README.md

Stoplight Studio

Studio is Stoplight's next generation application for API design, modeling, and technical writing. A primary goal of Studio is to enrich, not replace, your existing workflows. When running locally it works fully offline, with folders and files on your computer just like your favorite IDE. When running in the browser, the web-native Git support allows you to effortlessly work with your existing repositories safely and efficiently.

Full Support for OpenAPI v2 and v3

Studio comes with full support for the OpenAPI versions 2 and 3 specification formats for all functionality. That means full validation, mocking, and modeling support for both versions of the OpenAPI specification.

Studio loves Swagger + OpenAPI

Graphical API Design

Form-based designing means you don't need to be an OpenAPI expert to get started. Studio has a "write" (code) mode with full OpenAPI autocomplete, and a "read" mode for visualizing HTTP operations and models.

Graphical Design for OpenAPI

To find out more about how you can quickly design and prototype APIs without writing a single line of JSON or YAML, see here.

JSON Schema Modeling

Studio is not just for APIs, you can also create and modify standalone JSON Schema files for storing data models. Did we mention that this is also powered by the graphical interface? No more searching for the matching bracket or the missing space, and no need to be familiar with the in's and out's of JSON Schema.

Encourage Reuse, Avoid Duplication

When it comes to API modeling, avoiding duplication of effort can be the difference between success and failure. How can you enforce consistency if all of your endpoints re-create the same model in slightly different ways? (hint, you can't)

Studio's graphical JSON schema editor allows you to quickly find models to reference

Studio allows you to quickly and easily find and reuse the objects you need, as you need them. No more recreating models for different endpoints, no more having to update dozens of different endpoints because a new field was added.

To find out more about how you can leverage references to scale your API consistency, see here.

Technical Documentation

Mix API Reference Documentation and Markdown-based guides, how-tos, getting started information, etc. All of your documentation can live together in the same project. Studio includes a built-in Markdown editor, image manager, and the ability to publish documentation to Stoplight’s new documentation platform.

Create beautiful and easy-to-use API reference documentation

You can even host the files in your own Git repository, and then publish when you're ready to show off your latest and greatest.

To find out more about writing technical documentation in Studio, see our getting started guide here.

Stoplight-Flavored Markdown

Stoplight-flavored Markdown (SMD) is a fully compatible superset of CommonMark, the popular Markdown specification. SMD enables a few advanced block types that will enrich your user’s documentation experience, and includes options such as call-outs, tabs, JSON Schema elements, and HTTP "try it out" blocks.

Different themed elements are now supported with SMD

To find out more about the SMD format and how you can use it to improve your documentation, see here.

Style Guides and Validation

Enforce correctness and best practices with the native Spectral integration that alerts you to errors the moment they are created.

Spectral validates and lints your APIs to ensure they are correct and functional

Clicking on errors or warnings also brings you to exactly where they are located in the document, making it easy to fix errors at the source.

To find out more about Spectral and how validations can improve your API design workflow, see here.

Built-in Mocking

When running locally, Studio will automatically start a local Prism mock server for every API defined in your project, and keep that mock server up to date as you change your designs.

Mocking allows you to quickly test the look and feel of your API before jumping into the code

To find out more about Prism and how mocking can be used to streamline your API development process, see here.

Bring Your Own Repository

Since Studio works with your local filesystem, you can open up your API projects and start adding docs and designs alongside the actual implementation they are meant to describe. Once you're done, check it all into Git with your favorite Git client!

You can’t perform that action at this time.