mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-09 04:21:15 +00:00
daf030b7a8
* Remove extra 'resources' landing page, redirect from main one * Move custom plugins file to its own directory, add redirect to handle * docs: split the custom plugins page into one page per feature * docs: extend decorators explanation and link to it from the custom plugins section * docs: Fix all the links that were broken when I moved things * Apply excellent suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: Add examples of how to use the custom rule * docs: Replace the nested visitor example with an object rather than a function * Update custom-rules.md minor consistency edits * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: clearer explanation of skip, and finish a broken sentence * Update docs/custom-plugins/index.md Co-authored-by: Heather Cloward <heathercloward@gmail.com> * Apply suggestions from code review Co-authored-by: Adam Altman <adam@redoc.ly> * docs: use object rather than function for visitor --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com> Co-authored-by: Adam Altman <adam@redoc.ly>
118 lines
5.9 KiB
Markdown
118 lines
5.9 KiB
Markdown
# `preview-docs`
|
|
|
|
## Introduction
|
|
|
|
With this command, you can generate documentation previews for API definitions on your local machine.
|
|
|
|
If you have a license key or API key configured, the output is a preview of the premium [Redocly API reference docs](https://redocly.com/reference/). Otherwise, it is a preview of [Redoc community edition](https://redocly.com/redoc/).
|
|
|
|
:::success Tip
|
|
To preview docs using the premium Redocly API reference docs, you must first authenticate to the API registry with the [`login`](./login.md) command.
|
|
:::
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
redocly preview-docs <api>
|
|
redocly preview-docs <api> [--config=<path>] [--port=<value>] [--host=<host>]
|
|
redocly preview-docs <api> [--force] [--help] [--version]
|
|
redocly preview-docs <api> --version
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Type | Description |
|
|
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| api | string | Path to the API definition filename or alias that you want to generate the preview for. Refer to [the api section](#api) for more options. |
|
|
| --config | string | Specify path to the [configuration file](#custom-configuration-file). |
|
|
| --force, -f | boolean | Generate preview output even when errors occur. |
|
|
| --help | boolean | Show help. |
|
|
| --host, -h | string | The host where the documentation preview can be accessed. The default value is `127.0.0.1`. |
|
|
| --port, -p | integer | The port where the documentation preview can be accessed. You can set any port number over 1024 as long as it is not already being used. The default value is port `8080`. |
|
|
| --skip-decorator | [string] | Ignore [certain decorators](#skip-preprocessor-or-decorator). |
|
|
| --skip-preprocessor | [string] | Ignore [certain preprocessors](#skip-preprocessor-or-decorator). |
|
|
| --use-community-edition | boolean | Use Redoc Community Edition for docs preview. |
|
|
| --version | boolean | Show version number. |
|
|
|
|
## Examples
|
|
|
|
### Api
|
|
|
|
The command behaves differently depending on how you pass the api to it, and whether the [configuration file](#custom-configuration-file) exists.
|
|
|
|
#### Pass api directly
|
|
|
|
```bash
|
|
redocly preview-docs openapi/openapi.yaml
|
|
```
|
|
|
|
In this case, `preview-docs` previews the definition that was passed to the command. The configuration file is ignored.
|
|
|
|
#### Pass api alias
|
|
|
|
Instead of a full path, you can use an API name from the `apis` section of your Redocly configuration file.
|
|
|
|
```bash Command
|
|
redocly preview-docs core@v1
|
|
```
|
|
|
|
```yaml Configuration file
|
|
apis:
|
|
core@v1:
|
|
root: ./openapi/definition.json
|
|
```
|
|
|
|
In this case, after resolving the path behind the `core@v1` name (see the `Configuration file` tab), `preview-docs` generates a preview of the `definition.json` file. For this approach, the Redocly configuration file is mandatory.
|
|
|
|
### Custom configuration file
|
|
|
|
By default, the CLI tool looks for the [Redocly configuration file](../configuration/index.mdx) in the current working directory. Use the optional `--config` argument to provide an alternative path to a configuration file.
|
|
|
|
```bash
|
|
redocly preview-docs --config=./another/directory/config.yaml
|
|
```
|
|
|
|
### Custom port for preview
|
|
|
|
By default, without using the `port` option, the preview starts on port `8080`, so you can access the docs at `http://localhost:8080`
|
|
|
|
To specify a custom port for the preview, pass the desired value using either short or long option format:
|
|
|
|
```bash Short format
|
|
redocly preview-docs -p 8888 openapi/openapi.yaml
|
|
```
|
|
|
|
```bash Long format
|
|
redocly preview-docs -port 8888 openapi/openapi.yaml
|
|
```
|
|
|
|
Both commands start the preview on port `8888`, so you can access the docs at `http://localhost:8888`.
|
|
|
|
### Custom host for preview
|
|
|
|
By default, without using the `host` option, the preview starts on host `127.0.0.1`, so you can access the docs at `http://127.0.0.1:8080` or `http://localhost:8080`.
|
|
|
|
To specify a custom host for the preview, pass the desired value using either short or long option format:
|
|
|
|
```bash Short format
|
|
redocly preview-docs -h 0.0.0.0 openapi/openapi.yaml
|
|
```
|
|
|
|
```bash Long format
|
|
redocly preview-docs --host 0.0.0.0 openapi/openapi.yaml
|
|
```
|
|
|
|
Both commands start the preview on host `0.0.0.0`, so you can access the docs at `http://0.0.0.0:8080`
|
|
|
|
### Skip preprocessor or decorator
|
|
|
|
You may want to skip specific preprocessors, rules, or decorators upon running the command.
|
|
|
|
```bash Skip preprocessors
|
|
redocly preview-docs --skip-preprocessor=discriminator-mapping-to-one-of --skip-preprocessor=another-example
|
|
```
|
|
|
|
```bash Skip decorators
|
|
redocly preview-docs --skip-decorator=generate-code-samples --skip-decorator=remove-internal-operations
|
|
```
|