Skip to content

Commit a25ddad

Browse files
committed
docs(generators:endpoint): create endpoint.md
[skip ci]
1 parent 20cc9d3 commit a25ddad

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/generators/endpoint.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
### Endpoint
2+
Generates a new API endpoint.
3+
4+
Usage:
5+
```bash
6+
Usage:
7+
yo angular-fullstack:endpoint [options] <name>
8+
9+
Options:
10+
-h, --help # Print the generator's options and usage
11+
--skip-cache # Do not remember prompt answers Default: false
12+
--route # URL for the endpoint
13+
--models # Specify which model(s) to use Options: mongoose, sequelize
14+
--endpointDirectory # Parent directory for enpoints
15+
16+
Arguments:
17+
name Type: String Required: true
18+
```
19+
20+
Example:
21+
```bash
22+
yo angular-fullstack:endpoint message
23+
[?] What will the url of your endpoint be? /api/messages
24+
```
25+
26+
Produces:
27+
28+
server/api/message/index.js
29+
server/api/message/index.spec.js
30+
server/api/message/message.controller.js
31+
server/api/message/message.integration.js
32+
server/api/message/message.model.js (optional)
33+
server/api/message/message.events.js (optional)
34+
server/api/message/message.socket.js (optional)

0 commit comments

Comments
 (0)