Skip to content

Commit b40db23

Browse files
committed
docs: fix documentation regarding --api-devserver-url usage (#579)
1 parent d014fbd commit b40db23

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/www/docs/cli/swa-start.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Here is a list of the default ports used by some popular dev servers:
5151
| [Next.js](https://nextjs.org/) | 3000 | `swa start http://localhost:3000` |
5252
| [React (Create React App)](https://reactjs.org/docs/create-a-new-react-app.html) | 3000 | `swa start http://localhost:3000` |
5353
| [Svelte (sirv-cli)](https://github.com/lukeed/sirv/tree/master/packages/sirv-cli/) | 5000 | `swa start http://localhost:5000` |
54-
| [Vue](https://github.com/vuejs/create-vue) | 3000 | `swa start http://localhost:3000` |
54+
| [Vue](https://github.com/vuejs/create-vue) | 3000 | `swa start http://localhost:3000` |
5555

5656
Instead of starting a dev server separately, you can provide the startup command to the CLI.
5757

@@ -94,10 +94,10 @@ When developing your backend locally, sometimes it's useful to run Azure Functio
9494
To use the CLI with your local API backend dev server, follow these two steps:
9595

9696
1. Start your API using Azure Functions Core Tools: `func host start` or start debugging in VS Code.
97-
2. In a separate terminal, run the SWA CLI with the `--api-location` flag and the URI of the local API server, in the following format:
97+
2. In a separate terminal, run the SWA CLI with the `--api-devserver-url` flag and the URI of the local API server, in the following format:
9898

9999
```bash
100-
swa start ./my-dist --api-location http://localhost:7071
100+
swa start ./my-dist --api-devserver-url http://localhost:7071
101101
```
102102

103103
## Options
@@ -108,7 +108,7 @@ Here are the options you can use with `swa start`:
108108
- `-i, --api-location <path>`: the folder containing the source code of the API application
109109
- `-O, --output-location <path>`: the folder containing the built source of the front-end application. The path is relative to `--app-location` (default: ".")
110110
- `-D, --app-devserver-url <url>`: connect to the app dev server at this URL instead of using output location
111-
- `-is, --api-devserver-url <url>`: connect to the api server at this URL instead of using output location
111+
- `-is, --api-devserver-url <url>`: connect to the api server at this URL instead of using api location
112112
- `-j, --api-port <apiPort>`: the API server port passed to `func start` (default: 7071)
113113
- `-q, --host <host>`: the host address to use for the CLI dev server (default: "localhost")
114114
- `-p, --port <port>`: the port value to use for the CLI dev server (default: 4280)
@@ -157,7 +157,7 @@ swa start http://localhost:3000 --run-build "npm start"
157157
Connect both front-end and the API to running development server
158158

159159
```bash
160-
swa start http://localhost:3000 --api-location http://localhost:7071
160+
swa start http://localhost:3000 --api-devserver-url http://localhost:7071
161161
```
162162

163163
## See Also

docs/www/docs/use/3-api-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ To use the SWA emulator services alongside the API server:
2929
func host start
3030
```
3131

32-
2. Start SWA CLI in a separate terminal and use the `--api-location` option to pass it the relevant local API Server URI. _For example:_
32+
2. Start SWA CLI in a separate terminal and use the `--api-devserver-url` option to pass it the relevant local API Server URI. _For example:_
3333

3434
```bash
35-
swa start ./my-dist --api-location http://localhost:7071
35+
swa start ./my-dist --api-devserver-url http://localhost:7071
3636
```
3737

3838
## 4.3 Start API Server Automatically

0 commit comments

Comments
 (0)