Compare commits

...

45 Commits

Author SHA1 Message Date
Robert Wallach
70ef4d974f Update best-practices.md 2018-04-17 15:36:33 -05:00
Robert Wallach
f718d9c05a Create best-practices.md 2018-04-17 15:20:31 -05:00
Robert Wallach
e3ef236584 Update overview.md 2018-04-12 14:47:35 -05:00
Robert Wallach
cabc442e28 Update runtime.md 2018-04-12 14:44:13 -05:00
Robert Wallach
a254af1c20 Update introduction.md 2018-04-12 14:40:39 -05:00
Robert Wallach
957d2efd3b Update introduction.md 2018-04-12 14:39:26 -05:00
Robert Wallach
51431db9cc Update contract-testing.md 2018-04-12 14:32:07 -05:00
Robert Wallach
686b00e1e3 Update contract-testing.md 2018-04-12 14:30:34 -05:00
Robert Wallach
d515eda1a3 Update send-http-requests.md 2018-04-12 14:29:46 -05:00
Robert Wallach
cdabcf38df Update run-test-terminal.md 2018-04-12 14:26:18 -05:00
Robert Wallach
928662895f Update run-test-stoplight.md 2018-04-12 14:24:22 -05:00
Robert Wallach
04078e3d7e Update json-introduction.md 2018-04-12 14:19:33 -05:00
Robert Wallach
84bbc31f61 Update sending-http-requests.md 2018-04-12 14:15:44 -05:00
Robert Wallach
3b04cac2e9 Update modeling-introduction.md 2018-04-12 14:12:28 -05:00
Robert Wallach
952c5cad78 Update delete-team.md 2018-04-12 14:10:17 -05:00
Robert Wallach
117ec573f5 Update file-validation.md 2018-04-12 14:05:12 -05:00
Robert Wallach
a34e8a8ffe Update visibility.md 2018-04-12 13:55:25 -05:00
Robert Wallach
627f488a70 Update overview.md 2018-04-12 13:54:27 -05:00
Robert Wallach
0fcd0deb83 Update new-user-introduction.md 2018-04-12 13:53:47 -05:00
Robert Wallach
e813f534cc Update overview.md 2018-04-12 11:30:25 -05:00
Robert Wallach
428fc33108 Create fair-billing-policy.md (#208)
* Create fair-billing-policy.md

* Update fair-billing-policy.md

* Update fair-billing-policy.md
2018-04-11 16:30:03 -05:00
Robert Wallach
78b4477ab4 Create oauth for Hubs.md (#178)
* Create oauth.md

* Update oauth.md

* Update oauth.md

* Update oauth.md
2018-04-11 15:40:34 -05:00
Robert Wallach
e33d7a0c03 Update technical-writers.md 2018-04-11 15:38:32 -05:00
Robert Wallach
e46c67906e Delete writers.md 2018-04-11 15:32:34 -05:00
Robert Wallach
7702c1f4ad Rename writers.md to technical-writers.md 2018-04-11 15:32:22 -05:00
Robert Wallach
293bc16fdf Create writers-playbook.md (#209)
* Create writers-playbook.md

* add capitalization

* Update writers-playbook.md

* Update writers-playbook.md
2018-04-11 15:29:46 -05:00
Taylor Barnett
a413f2598f How to clone a git repo from Stoplight (#210)
* WIP

* WIP

* copy fixes

* add image URL

* remove double parentheses

* add line clarifying what article does

* Update git.md

* Update git.md

* fix conflict
2018-04-11 10:05:50 -05:00
Robert Wallach
b1149e0b7b Add files via upload 2018-04-10 14:35:59 -05:00
Robert Wallach
b2aee5c4d0 Update blocks.md 2018-04-10 11:28:23 -05:00
Robert Wallach
8f044d4901 Update introduction.md 2018-04-06 12:46:40 -05:00
Thomas Pytleski
e6b6c7d3bb Articles/prism/overview.md (#206)
* - prism overview article

* Update overview.md

* Update overview.md

* - cleaning up prism introduction article

* - need to add related links

* - add prism helpers

* Update introduction.md

* - add images/gifs to the prism introduction

* - update gif for mocking
2018-04-06 12:43:19 -05:00
Robert Wallach
00b3727a25 Update custom-css.md (#174)
* Update custom-css.md

* add hubBlock

* Update custom-css.md
2018-04-06 11:25:00 -05:00
Robert Wallach
6f68aff756 Update introduction.md 2018-04-06 11:17:29 -05:00
Robert Wallach
8dd22c674f Delete prism-introduction-mock.gif 2018-04-06 11:15:47 -05:00
Robert Wallach
3cb3a1ccad Add files via upload 2018-04-06 10:59:11 -05:00
Robert Wallach
36d72d4089 Delete prism-introduction-conduct.gif 2018-04-06 10:58:56 -05:00
Robert Wallach
892bfc69c5 Add files via upload 2018-04-06 10:58:26 -05:00
Robert Wallach
9544dad308 Delete prism-introduction-help.png 2018-04-06 10:58:11 -05:00
Thomas Pytleski
3c5d9bf54e [WIP] prism overview article (#161)
* - prism overview article

* Update overview.md

* Update overview.md

* - cleaning up prism introduction article

* - need to add related links

* - add prism helpers

* Update introduction.md

* - add images/gifs to the prism introduction
2018-04-06 10:52:59 -05:00
Robert Wallach
1afe7ad92e Add files via upload 2018-04-05 14:43:39 -05:00
Robert Wallach
56fd2dc65d Add files via upload 2018-04-05 14:43:21 -05:00
Robert Wallach
4d843f4937 Delete hubs-oauth-code.png 2018-04-05 14:43:05 -05:00
Robert Wallach
db454a5e68 Add files via upload 2018-04-05 13:36:38 -05:00
Robert Wallach
f597a2cfb9 Create permissions-overview.md 2018-04-03 16:22:40 -05:00
Robert Wallach
a5bb2aa9a5 Add files via upload 2018-04-03 15:41:22 -05:00
34 changed files with 398 additions and 134 deletions

View File

@@ -0,0 +1,11 @@
# Fair Billing Policy
Stoplight's Fair Billing Policy means you will only be charged for active users in any given billing cycle. We adopted the Fair Billing Policy because we believe you should only pay for what you use. We also wanted to avoid setting strict user limits because it can lead to workflow bottlenecks and promotes poor engineering practices.
## Active User
To be considered an active user, you must perform one of the following actions:
- Push a commit
- Write or modify a file
- Publish documentation
> If you do not perform on of these actions durign a billing cycle, you will be considered inactive, and will not count towards your user count for that billing cycle.

View File

@@ -1,43 +1,43 @@
# Personal Billing Overview
![Billing Overview](https://github.com/stoplightio/docs/blob/develop/assets/images/billing.png?raw=true)
## Platform Plans
### Open Source
- Price: Free
- Features:
- API Modeling
- Documentation
- Mocking
- Testing
### Developer
- Price: $9/month
- Features:
- Unlimited Private Projects
- Coming Soon: Github Integration
## Documentation Plans
### Basic
- Price: Free
- Features:
- Unlimited Visits
- Publish to .docs.stoplight.io
- Docs & OpenAPI Editors
### Essential
- Price: $79/month
- Features:
- Publish to your Domain (1 domain)
- Theming
- Build History & Instant Rollbacks
### Standard
- Price: $179/month
- Features:
- Publish to your Domain (10 domains)
- Custom CSS
- White Label
- Basic Auth & Auth0 Integration
# Personal Billing Overview
![Billing Overview](https://github.com/stoplightio/docs/blob/develop/assets/images/billing.png?raw=true)
## Platform Plans
### Open Source
- Price: Free
- Features:
- API Modeling
- Documentation
- Mocking
- Testing
### Developer
- Price: $9/month
- Features:
- Unlimited Private Projects
- Coming Soon: Github Integration
## Documentation Plans
### Basic
- Price: Free
- Features:
- Unlimited Visits
- Publish to .docs.stoplight.io
- Docs & OpenAPI Editors
### Essential
- Price: $79/month
- Features:
- Publish to your Domain (1 domain)
- Theming
- Build History & Instant Rollbacks
### Standard
- Price: $179/month
- Features:
- Publish to your Domain (10 domains)
- Custom CSS
- White Label
- Basic Auth & Auth0 Integration

View File

@@ -1,7 +1,7 @@
# Web & Desktop App
Stoplight has a desktop app! Download the appropriate version [here](https://stoplight.io/download) .
Stoplight has a desktop app! Download the appropriate version [here](https://github.com/stoplightio/desktop/releases/latest).
## Web or Local?

View File

@@ -22,4 +22,4 @@ Different types of file validations are used throughout the Stoplight platform.
**Related Articles**
* [Validating Your API Spec](/modeling/modeling-with-openapi/validating-your-api-sec)
* [Validating Your API Spec](/modeling/modeling-with-openapi/validating-your-api-spec)

View File

@@ -1,6 +1,6 @@
# Welcome to Stoplight Next!
Now that you have the basics on what the [Stoplight Next Platform](/platform/introduction) is, we can go over how to get started.
Now that you have the basics on what the [Stoplight Next Platform](/platform/what-is-stoplight) is, we can go over how to get started.
First things first, are you using Stoplight for Personal Projects or as part of an Organization?

View File

@@ -0,0 +1,36 @@
# Permissions & Governance Overview
## Organizations
| **Organization Actions** | **Guest** | **Member** | **Administrator** | **Owner** |
|---------------------------------|:-----------:|:------------:|:-------------------:|:-----------:|
| Read Public Projects | X | X | X | X |
| View Organization Collaborators | | X | X | X |
| View Organization Teams | | X | X | X |
| Create Projects | | X | X | X |
| Read Private Projects | | X | X | X |
| Write Projects | | | X | X |
| Manage Collaborators | | | X | X |
| Manage Teams | | | X | X |
| Manage Organization Settings | | | | X |
| Manage Organization Billing | | | | X |
| Delete Organization | | | | X |
## Teams
| **Team Actions** | **Member** | **Administrator** | **Owner** |
|-------------------------|:------------:|:-------------------:|:-----------:|
| View Team Collaborators | X | X | X |
| Add Team to Projects | X | X | X |
| Manage Team Collaborators | | X | X |
| Manage Team Settings | | X | X |
| Delete Team | | | X |
## Projects
| **Project Actions** | **Read** | **Write** | **Administrator** |
|------------------------------|:--------:|:---------:|:-----------------:|
| Read Project | X | X | X |
| Write Project | | X | X |
| Manage Project Collaborators | | | X |
| Delete Project | | | X |

View File

@@ -0,0 +1,44 @@
# Hubs Best Practices
## Supplementary/Auxiliary Documentation
Documentation is a principal driving force for great UX. APIs require basic referential material for consumption, but great UX comes from all of the supplementary information you provide your users. To support the creation of any number of different supplementary documents, images, videos, etc. we created Hubs, our documentation tool. We pushed the limits of API documentation beyond specifications and models to accommodate all of the secondary and tertiary information that can help drive good UX.
## Referencing Other Files/ Git Repo for Open Sourcing Docs
Open sourcing your documentation can provide a number of advantages including more engagement and content. Users and businesses often create their own supplemental documents supporting their own unique use cases. By providing a Github repo, these users and companies can contribute their unique documentation to your docs enhancing your UX. Stoplights Hubs has a ref builder that allows you to directly reference any markdown and YAML files. Create and store your markdown files in a Github Repo or other file sharing platform and directly reference them in Hubs. This workflow also gives the added benefit of changes made to any markdown files being automatically reflected in your documentation.
## Structure
### Table of Contents
One of Stoplights central principles is a single source of truth. We applied this principle to Hubs by adding in a Table of Contents. The Table of Contents is a birds eye view of the structure of your docs that allows you to strategize and manipulate the structure of your docs.
### Pages
Pages function similarly to chapters in a book. They group similar content together at the broadest scope. We recommend adding pages sparingly to keep your documentation concise and easily navigable. Connect pages via headers in Hub Settings.
### Subpages
If pages are the chapters of a book, subpages are sections within chapters. Create a subpage for each topic you wish to address. The scope should be as narrow as possible to help your users more easily navigate your documentation. New subpages auto-populate the sidebar navigation of a page. Drag and drop in the navigation for structural adjustments and create empty subpages to create navigational headers to further clarify structure.
## Integrations
Integrations are quickly becoming core elements of any platform. Stoplights Hubs provides easy integrations to satisfy the most popular builds. Add a Google Analytics integration to track your documentation consumers activity. Integrate Intercom into your documentation to provide additional support. Add a Segment integration for any other integrations supported by Segment.
## SEO
SEO is important in any content including documentation. Use a Google Analytics integration to optimize your documentation for Google.
## Routing
Routing ties into SEO but is also an important aspect of a well structured and organized document. Create easily readable routes that identify your content accurately to maximize the SEO of your documentation. Use the Table of Contents to view the connections between pages and subpages to make clever use of routes. Add Page tags for additional clarification on what kind of content is housed within.
## Design
Documentation design is not just a pretty package for your content. It impacts a number of different aspects of your business including marketing, branding, and UX. Use theming for marketing and branding purposes to make simple global style adjustments. Most businesses have 2-3 primary colors that can be applied to your docs through theming. For more advanced design, use Custom CSS to have complete control of the style of your documentation.
---
**Related Links**
- [Documentation with Hubs](/documentation/introduction)
- [Routing](/documentation/getting-started/routing)
- [Headers](/documentation/getting-started/header-footer)
- [Pages](/documentation/getting-started/pages)
- [Subpages](/documentation/getting-started/subpages)
- [Blocks](/documentation/blocks)
- [Referencing Other Data Sources](/documentation/referencing-other-data-sources)
- [Publishing](/documentation/publishing)
- [Theming](/documentation/design/theming)
- [Custom CSS](/documentation/design/custom-css)

View File

@@ -1,6 +1,6 @@
# Blocks
![Blocks](https://github.com/stoplightio/docs/blob/develop/assets/gifs/blocks.gif?raw=true)
![Blocks](https://github.com/stoplightio/docs/blob/develop/assets/gifs/Blocks.gif?raw=true)
## What
Blocks are the micro-level building blocks of Hubs. They house multiple forms of content and allow for simple restructuring and modification.
@@ -22,12 +22,6 @@ Blocks are the micro-level building blocks of Hubs. They house multiple forms of
* An upper level block for organizing text within tabs
### Callout
* A text block with color for emphasis
### Hero
* A large stylized text block with additional functionality typically found on landing pages
### Bar List
* A navigational block composed of bars with buttons
### Card List
* A navigational block composed of cards with text, buttons, and optional images
### HTML
* Include arbitrary HTML in your hubs when the other base block types don't quite do the trick
@@ -35,7 +29,7 @@ Blocks are the micro-level building blocks of Hubs. They house multiple forms of
**Related Articles**
- [Documentation with Hubs](/documentation/introduction)
- [Routing](/documentation/getting-started/routing)
- [Headers & Footers](/documentation/getting-started/header-footer)
- [Headers](/documentation/getting-started/header-footer)
- [Pages](/documentation/getting-started/pages)
- [Subpages](/documentation/getting-started/subpages)
- [Referencing Other Data Sources](/documentation/referencing-other-data-sources)

View File

@@ -1,11 +1,17 @@
# Custom CSS
![Applying Custom CSS](https://github.com/stoplightio/docs/blob/develop/assets/gifs/hubs-custom-css.gif?raw=true)
## What
Want to add some style and flair to your documentation? Add your own custom CSS to enhance your Hubs look and feel. Below are some of the classes you can modify:
```
.Hub
.HubHeader
.HubHeader-section
.HubHeaderItem.is-active
.HubHeaderItem-name
.HubHeaderItem-name
.HubMain
.HubSidebar-overlay
.HubSidebar-wrapper
@@ -17,7 +23,24 @@
.HubPage-inner
.HubPage-content
.HubPageCrumbs
.HubPageCrumb
.HubPageBody
.HubPageCrumb
.HubPageBody
.HubBlock
.HubPageFooter
```
## How
1. Select the Hub you wish to modify
2. Select the **Design View**
3. Click on **Theme** in the top toolbar
4. Select **Custom CSS** in the bottom left
5. Input CSS in the text area at the bottom of the page
6. Input CSS in the generated **theme** file (optional)
7. In publishing, check the **Custom CSS** box under **Advanced** to apply the Custom CSS to that Hub when published
>After accessing Custom CSS, a **theme** file will be generated under Documentation in the file explorer. After making changes to your CSS, make sure to save the **theme** file.
---
**Related Articles**
- [Theming](/documentation/design/theming)

56
articles/hubs/oauth.md Normal file
View File

@@ -0,0 +1,56 @@
# OAuth for Hubs
## What
OAuth provides a level of security to your documentation to restrict access to it. Enabling OAuth in Hubs can be accomplished through two different methods: via Modeling or directly into the Hubs code.
> Stoplight supports OAuth 1.0 and 2.0
## How
### Modeling
![OAuth in Modeling](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-modeling.png?raw=true)
1. Create a new Modeling file or select an existing one referenced by the Hub you wish to modify
> If you are creating a new Modeling file, make sure to reference it in your Hub
2. Next to **Security** in the left-middle toolbar, Add a Security Scheme by clicking the **+**
3. Input a **key**
4. Select oauth2 under **type**
5. Select **accessCode** under OAuth **flow**
6. Select an **authorization url**
7. Select a **token url**
8. **Add Scope** (optional)
9. Add a **Security scheme description** (optional)
### Hubs
![OAuth in Hubs](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-code.png?raw=true)
1. Select the Hub you wish to modify
2. Select **Code View**
3. Add the following lines of code to your Hub:
```
"config": {
"http": {
"oauth2": {
"credentials": {
"authorize_url": "insert authorize url here",
"access_token_url": "insert access token url here",
}
}
}
}
```
---
**Related Articles**
- [Digital Oceans: Introduction to OAuth2](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2)
- [Security Schemes](/modeling/modeling-with-openapi/security-schemes)

View File

@@ -43,7 +43,7 @@ There are many benefits to using JSON, some of which include:
be written in YAML, so either format can be used to write OpenAPI specifications
* It can be used to link files together through [JSON
references](/modeling/introduction/modeling-with-openapi/referencing-another-api-spec), making it easy to break up large documents
references](/modeling/modeling-with-openapi/referencing-another-api-spec), making it easy to break up large documents
into smaller, more focused documents
Whether you are modeling an API, creating a Prism Collection, or writing

View File

@@ -30,4 +30,4 @@ There are a few ways to get started designing your API with the Stoplight design
- Create an API from scratch [Using the CRUD Builder](/modeling/modeling-with-openapi/using-the-crud-builder)
- [Reference another API Spec](/modeling/modeling-with-openapi/referencing-another-api-spec)
- [Send HTTP Requests](/modeling/modeling-with-openapi/sending-http-requests) to an existing API Spec
- [Validate your API Spec](/modeling/modeling-with-openapi/validating-your-api-sec)
- [Validate your API Spec](/modeling/modeling-with-openapi/validating-your-api-spec)

View File

@@ -31,4 +31,5 @@ Use the HTTP Request Maker to send requests to the endpoints defined in your spe
---
**Related Articles**
[Using Environment Variables](/testing/using-variables/environment)
- [Using Environment Variables](/testing/using-variables/environment)

View File

@@ -0,0 +1,43 @@
# Technical Writer Playbook
Documenting an API is crucial to its success but can be extremely time consuming. Here at Stoplight, we believe documentation should be beautiful, clean, and robust while maintaining a streamlined turnaround time. Weve created a holistic documentation tool, Hubs, to address some of the problems our users were facing including:
- Documenting Endpoints
- Testing Endpoints
- Creating Non-Reference Documentation
- Managing Content
- External and Internal Referencing
- Design and Style
## Documenting Endpoints
The most key component to API Documentation are its endpoints. To that end, we created a reference builder that allows you to [“power pages”](/documentation/referencing-other-data-sources) with your specification as you see fit. When you power a page or subpage with your specification, the endpoints are automatically documented and styled for legibility and aesthetic design.
## Testing Endpoints
Testing endpoints is a valuable tool for anyone who wants to consume your API. Users want to know that your API functions properly before they commit to using it. To address this problem, we created [“Try it Out,” an HTTP Request Maker](/modeling/modeling-with-openapi/sending-http-requests). Try it Out allows you to send HTTP Requests to your API to test out its endpoints under any number of different conditions. You can customize Try it Out with security schemes, variables, headers, queries, and it even generates code in various programming languages.
## Creating Non-Reference Documentation
Great documentation is more than just API endpoints. Guides, tutorials, and other supplemental information enhance your users experience by providing them with all the information they need to access your API and your product. We broadened Hubs scope to accomodate all product documentation needs. You can easily build out your content within [Blocks](/documentation/blocks), a number of flexible content structures that can house a number of different forms of content including markdown, images, code snippets, and much more.
## Managing Content
Organizing a complex APIs endpoints and supplemental information can be a challenging task. Some specification can have hundreds of endpoints with supplemental information throughout. To assist with organizing content, we created an overview of all your pages, subpages, and their connections called “Table of Contents”. With a birds eye view of your content, you can easily organize and manage your content through drag drop functionality.
## External and Internal Referencing
To accomodate a larger variety of writing workflows, we expanded the capabilities of [Powering a Page](/documentation/referencing-other-data-sources) to allow for more files internally and externally to be referenced. You can now easily reference internal or external specifications, and Markdown, YAML, JSON, and Scenario files.
## Design and Style
We wanted to create a new, beautiful, minimalistic, efficient design for less design-oriented individuals while allowing for customization. Hubs was designed to display your documentation in a neat, efficient structure, designed specifically for displaying the real beauty, your API. On the other hand, we didnt want to stifle the creativity that goes into documentation design so we added in [theming](/documentation/design/theming) and [custom CSS](/documentation/design/custom-css). We also made it easier to add navigation, different kinds of content, and a more robust search.
---
Related Links
- [Documentation with Hubs](/documentation/introduction)
- [Routing](/documentation/getting-started/routing)
- [Headers](/documentation/getting-started/header-footer)
- [Pages](/documentation/getting-started/pages)
- [Subpages](/documentation/getting-started/subpages)
- [Blocks](/documentation/blocks)
- [Referencing Other Data Sources](/documentation/referencing-other-data-sources)
- [Publishing](/documentation/publishing)
- [Theming](/documentation/design/theming)
- [Custom CSS](/documentation/design/custom-css)

View File

@@ -0,0 +1,59 @@
# Introduction
Prism is a proxy and API server toolkit that helps you test, mock, validate, and orchestrate your online applications. We rebuilt Prism from the ground up to be performant, powerful, and programmable while still being practical. Prism enables teams to work in parallel and iterate faster with less errors. The Stoplight Platform integrates tightly with Prism to generate test coverage of your API automatically, build tests visually, and create mock and contract servers instantly.
Prism has first class support for the OpenAPI Specification (aka OAS) and Stoplight Scenarios. OAS is machine readable documentation of your API that Prism can read and understand. Scenarios tell Prism how to orchestrate your API. When you use them together you can easily assert, transform, and validate your API against your OAS. Prism also allows your front-end team to work in tandem with your back-end team. While the back-end team implements your API, your front-end teams can implement against a mock server that can return static examples, dynamic data, or replay actual traffic from your API.
![Prism Overivew](https://github.com/stoplightio/docs/blob/develop/assets/images/prism-introduction-help.png?raw=true)
## Features
* Act as a mock server, routing incoming requests to example responses, or dynamically generating examples on the fly
* Act as a transformation layer, manipulating incoming requests and outgoing responses
* Act as a validation layer, validating incoming requests, and outgoing responses
* Contract test your APIs
* Extend existing APIs with new endpoints or capabilities
* Act as a system-wide proxy, blocking traffic to particular websites or endpoints
## Conduct vs Serve
Conduct and Serve are important concepts to understand when using Prism.
* Conduct is an isolated scenario run. You tell Prism what scenarios you want to run, give it an environment to run against, and Prism will generate a report of the run
* Serving, on the other hand, is a long running instance of Prism that applies scenarios to HTTP traffic
### Conduct Use Cases
1. Debugging your API implementation or specification
2. Integrating with your CI/CD Environment: Catch bugs before they get to your actual API Consumers
3. Webhooks: Generate your OAS from code, automatically upload it to Stoplight
![Prism Conduct](https://github.com/stoplightio/docs/blob/develop/assets/gifs/prism-introduction-conduct.gif?raw=true)
### Serve Use Cases
1. Mocking back one or more specifications: Useful to help teams work in parallel and simplify testing dependencies.
2. Validating live traffic between your client/backend.
3. Your API, your workflow, your Prism. Prism is very flexible. You can easily create an instance that will record your API traffic, save it to S3, and then create another instance that will replay that API traffic.
![Mock Server](https://github.com/stoplightio/docs/blob/develop/assets/gifs/prism-introduction-mock.gif?raw=true)
### Stoplight Prism Helpers
The [Prism Helpers](https://next.stoplight.io/stoplight/prism) project is a collection of scenarios, specifications, and Prism instances that illustrate how to use Prism effectively. Please go [here](https://community.stoplight.io) and let us know what you would like to see.
---
**Related Articles**
* [Javascript Runtime](/mocking/javascript-runtime)
* [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
* [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
* [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
* [Using Variables Overview](/testing/using-variables/overview)
* [$$.env (Environment)](/testing/using-variables/environment)
* [$.ctx(Context)](/testing/using-variables/context)
* [Sending HTTP Requests](/testing/sending-http-requests/overview)
* [Contract Testing](/testing/leveraging-openapi/contract-testing)
* [Integrating in Continuous Integration](/testing/continuous-integration/overview)

View File

@@ -1,61 +0,0 @@
# Mocking with Prism
Prism is a performant, dependency free server, built specifically to work with web APIs.
### Features
- Act as a mock server, routing incoming requests to example repsonses, or dynamically generating examples on the fly.
- Act as a transformation layer, manipulating incoming requests and outgoing responses.
- Act as a validation layer, validating incoming requests and outgoing responses.
- Contract test your APIs, given an OAS(Swagger 2) file.
- Log all or a subset of traffic to configurable locations.
- Extend existing APIs with new endpoints or capabilites.
- Act as a system-wide proxy, blocking traffic to particular websites or endpoints.
### Simplicity Redefined
Run it anywhere. It runs on OS X, Windows, and Linux, with no external dependencies. It is a single, self-contained binary file, that you can easily run from your terminal with a single command.
## Getting Started
#### macOS and Linux
```# Install Prism
curl https://raw.githubusercontent.com/stoplightio/prism/master.install.sh | sh
```
#### Windows
Download the appropriate binary from [here](https://github.com/stoplightio/prism/releases). Unzip the binary file, then navigate in your terminal to the folder where you extracted Prism.
### Run a Simple Mock Server
Prism understands OAS(Swagger 2), so let's get started by spinning up a quick mock server for the popular Petstore API. To do this, run the following command in your terminal:
```# os x / linux
prism run --mock --list --spec http://petstore.swagger.io/v2/swagger.json
# windows
path/to/prism.exe run --mock --list --spec http://petstore.swagger.io/v2/swagger.json
```
Here, you are using the "run" command to run a server based on the spec file passed in via the --spec argument. The spec location can be the filepath to a file on your computer, or the URL to a publicly hosted file. The mock argument tells Prism to mock all incoming requests, instead of forwarding them to the API host described in the spec file. The list argument is a convenience, and tells Prism to print out the endpoints in the spec on startup.
Prism starts on port 4010 by default - try visiting ```http://localhost:4010/v2/pet/findByStatus``` in your browser. This is one of the endpoints described in the petstore spec you passed in. You'll notice that it returns an error about a required query string parameter "status". This is the automatic request validation at work! The swagger spec specifies that a query string parameter names "status" is required for this endpoint so Prism simulates a 400 response for you. Reload the page with a query string parameter, and you will see the dynamically generated mock response ```http://localhost:4010/v2/pet/findByStatus?status=available```.
Tada! With a single command you have started a validating, dynamically mocking version of the Swagger petstore API.
### Run some Contract Tests
Prism consumes OAS(Swagger 2) files. OAS provides the contract for your API. If your OAS file contains the x-tests extension (generated automatically if you use the Stoplight app to manage your OAS and tests) then you can run tests with Prism.
Check out [this specification](https://goo.gl/jniYmw). If you scroll past all the regular OAS properties, you will notice a ```x-tests``` extension near the bottom of the file. Inside of that property, we have a few test cases defined. This OAS file, along with its tests, is managed in the Stoplight app (we export our API from within the app to produce this file).
#### To Run the Contract Tests
```
# os x / linux
prism test --spec https://goo.gl/jniYmw
# windows
path/to/prism.exe test --spec https://goo.gl/jniYmw
```
You should see some nice output to your terminal detailing the tests and assertions that are run. These tests take our OAS contract and apply it to your API. They act as a sort of sync manager.
> If a test fails, it means one of two things - your API is broken or, our OAS contract is out of date / incorrect

View File

@@ -120,10 +120,11 @@ var data = SL.schema.generate(contract);
#### Find Operation
The code snippet below describes the Stoplight representation of an HTTP operation. It is loosely based on OAS 3. You can find more descriptions of some of the properties described below [here](https://swagger.io/specification/#operationObject).
```js
/**
*
* This describes the Stoplight representation of an HTTP operation. It is loosely based on OAS 3. You can find more descriptions of some of the properties described below here: https://swagger.io/specification/#operationObject.
*
* @typedef {Object} Operation
* @property {string} method

61
articles/projects/git.md Normal file
View File

@@ -0,0 +1,61 @@
# Git Repositories
## What
The Stoplight Platform is built on top of Git. This means that all your projects are Git repositories and that our platform benefits from all the additonal functionality provided by Git. To access the Git funtionality, you will need to clone your Git repository by generating an Access Token.
> You can also use Access Tokens to access the Stoplight API, authenticate Prism in a continuous integration enviornment, and access the underlying Git repositories for projects. You can make this part of your Git workflow, add it to scripts, or your CI/CD process
## Who
If you have write access to a project, you will be able to:
* Pull projects via Git
* Commit to projects via Git
* Push changes to projects via Git
If you have read access to a project, you will be able to:
* Pull your project via Git
## How to Clone Your Stoplight Git Repository
1. Select the **Settings** tab on the platform homepage
2. Select **Access Tokens** from the left
![Access Tokens](https://github.com/stoplightio/docs/blob/develop/assets/images/access-tokens.png?raw=true)
3. Create a token to access projects that your Stoplight account has proper permissions for (These permissions match the ones in the Stoplight UI)
> You can name your token whatever you want. Once you have created the token, copy it, and only store it in a safe location. Once you close the window, you will not see it again
3. On your machine, store your access token as an environmental variable (recommended)
For example, on Mac/Linux:
```
export STOPLIGHT_TOKEN="1234567890"
```
4. You can then `git clone` the repo, replace `{stoplight-username}`, `{username}`, and `{project-name}` with the appropriate information:
```
git clone https://{stoplight-username}:$STOPLIGHT_TOKEN@git.stoplight.io/{username}/{project-name}.git
```
For example:
```
git clone https://taylor:$STOPLIGHT_TOKEN@git.stoplight.io/taylor/test-new.git
```
> If the project is associated with an organization and not a personal project, replace `username` with `organization-name`
5. Now you can make changes to your files, commit, and push to your master branch. You can see these changes in the Stoplight UI as well as the "History of Changes"
> Remember: You will only see changes on the master branch in the UI at this time.
---
**Related Articles**
- [Change a Project Member's Role](/platform/projects/change-a-members-role)
- [Make Your Project Private/Public](/platform/projects/visibility)
- [Invite People to Organization](/platform/organizations/invite-people)
- [Add People to a Team](/platform/organizations/teams/add-people)

View File

@@ -1,4 +1,4 @@
## Making Your Project Private & Public
# Making Your Project Private & Public
![Project Visibility](https://github.com/stoplightio/docs/blob/develop/assets/images/project-make-public.png?raw=true)

View File

@@ -19,4 +19,4 @@
**Related Articles**
- [Delete an Organization](/platform/organizations/delete-org)
- [Transfer Ownership of a Team](/platform/organizations/teams/transfer-ownership)
- [Delete a Team](/platform/organizations/teams/delete)

View File

@@ -86,7 +86,6 @@ Any validation errors will automatically be added to the test results.
---
**Related Articles**
- [Testing Introduction](/testing/introduction)
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
@@ -94,4 +93,4 @@ Any validation errors will automatically be added to the test results.
- [$$.env (Environment)](/testing/using-variables/environment)
- [$.ctx(Context)](/testing/using-variables/context)
- [Sending HTTP Requests](/testing/sending-http-requests/overview)
- [Referencing other Scenarios](/testing/referencing-other-scenarios/overview)

View File

@@ -24,11 +24,10 @@ API tests provide insight into how your API behaves under certain scenarios and
Microservices and serverless architecture have made it easier than ever to iterate quickly. The downside of rapid development is an increase in bugs and technical debt, making projects harder to manage without a proper testing solution. It is critical to have a comprehensive test suite to allow teams to test the API during development.
>Stoplight makes it easy to create a full suite of tests by providing [Environment](/testing/using-variables/environment) and [Context variables](/testing/using-variables/context), and the ability to [reference other scenarios](/testing/referencing-other-scenarios/overview) to accelerate test generation and reduce duplication.
>Stoplight makes it easy to create a full suite of tests by providing [Environment](/testing/using-variables/environment) and [Context variables](/testing/using-variables/context), and the ability to reference other scenarios to accelerate test generation and reduce duplication.
---
**Related Articles**
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)
@@ -36,8 +35,7 @@ Microservices and serverless architecture have made it easier than ever to itera
- [$$.env (Environment)](/testing/using-variables/environment)
- [$.ctx(Context)](/testing/using-variables/context)
- [Sending HTTP Requests](/testing/sending-http-requests/overview)
- [Referencing other Scenarios](/testing/referencing-other-scenarios/overview)
- [Contract Testing](testing/leveraging-openapi/contract-testing)
- [Contract Testing](/testing/leveraging-openapi/contract-testing)
- [Integrating in Continuous Integration](/testing/continuous-integration/overview)
- [Integrating with Jenkins](/testing/continuous-integration/jenkins)
- [Integrating with Travis](/testing/continuous-integration/travis)

View File

@@ -7,7 +7,7 @@ way is through the Stoplight editor.
> If you haven't created your first scenario yet, please [do so before
> continuing](testing/introduction)
> continuing](/testing/introduction)
Scenarios in Stoplight are composed of three different levels:

View File

@@ -63,11 +63,11 @@ You can also run a contract test against a specific upstream URL with the
prism validate --spec /path/to/my/spec.json --upstream http://localhost:8080
```
For more information on contract testing and how it can be used, see [here](testing/leveraging-openapi/contract-testing).
For more information on contract testing and how it can be used, see [here](/testing/leveraging-openapi/contract-testing).
---
**Related Articles**
- [Testing Introduction](/testing/introduction)
- [Contract Testing](testing/leveraging-openapi/contract-testing)
- [Contract Testing](/testing/leveraging-openapi/contract-testing)
- [Integrating in Continuous Integration](/testing/continuous-integration/overview)

View File

@@ -110,7 +110,6 @@ platforms.
---
**Related Articles**
- [Testing Introduction](/testing/introduction)
- [Passing Data Between Steps](/testing/getting-started/passing-data-between-steps)
- [Running Tests In Stoplight](/testing/running-tests/in-stoplight)
- [Running Tests in the Terminal](/testing/running-tests/in-the-terminal)
- [Running Tests Triggered by URL](/testing/running-tests/triggering-by-url)

View File

Before

Width:  |  Height:  |  Size: 871 KiB

After

Width:  |  Height:  |  Size: 871 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB