nestia 2.0.8 → 2.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -7
- package/bin/executable/nestia.js +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -150,7 +150,8 @@ Write below content as the `nestia.config.ts` file and place it onto the root di
|
|
|
150
150
|
```typescript
|
|
151
151
|
export = {
|
|
152
152
|
input: "src/controllers",
|
|
153
|
-
output: "src/api"
|
|
153
|
+
output: "src/api",
|
|
154
|
+
assert: false
|
|
154
155
|
};
|
|
155
156
|
```
|
|
156
157
|
|
|
@@ -160,10 +161,11 @@ export = {
|
|
|
160
161
|
> export = {
|
|
161
162
|
> input: "src/**/*.controller.ts",
|
|
162
163
|
> /* input: {
|
|
163
|
-
> include: ["src/controllers
|
|
164
|
-
> exclude: ["src/controllers
|
|
164
|
+
> include: ["src/controllers/**\/*.controller.ts"],
|
|
165
|
+
> exclude: ["src/controllers/**\/fake_*.controller.ts"]
|
|
165
166
|
> },*/
|
|
166
|
-
> output: "src/api"
|
|
167
|
+
> output: "src/api",
|
|
168
|
+
> assert: true
|
|
167
169
|
> }
|
|
168
170
|
> ```
|
|
169
171
|
|
|
@@ -196,9 +198,19 @@ For your deep understanding about this directory structure with this **Nestia**,
|
|
|
196
198
|
## Demonstration
|
|
197
199
|
To demonstrate which SDK codes would be generated by this **Nestia**:
|
|
198
200
|
|
|
199
|
-
-
|
|
200
|
-
|
|
201
|
-
|
|
201
|
+
- Representative files
|
|
202
|
+
- [Controllers of the NestJS](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/default/src/controllers/base/SaleCommentsController.ts)
|
|
203
|
+
- [Structures used in the RestAPI](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/default/src/api/structures/sales/articles/ISaleArticle.ts)
|
|
204
|
+
- [SDK generated by this **Nestia**](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/default/src/api/functional/consumers/sales/reviews/index.ts)
|
|
205
|
+
- Demonstration Projects
|
|
206
|
+
- [absolute](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/absolute): Absolute path with the `baseUrl` option
|
|
207
|
+
- [alias@api](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/alias@api): The `src/api` directory has been aliased by `paths` option
|
|
208
|
+
- [alias@src](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/alias@src): Entire `src` directory has been aliased by `paths` option
|
|
209
|
+
- [default](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/default): No `tsconfig.json` and `nestia.config.ts`
|
|
210
|
+
- [exclude](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/exclude): Exclude option using the `--exclude` commad
|
|
211
|
+
- [nestia.config.ts](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/nestia.config.ts): Configured `nestia.config.ts` with `assert` mode
|
|
212
|
+
- [reference](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/reference): Configured input files as `src/**/*.controller.ts`
|
|
213
|
+
- [tsconfig.json](https://github.com/samchon/nestia/tree/master/src/test/demonstrations/tsconfig.json): Special configuration through the `tsconfig.json`
|
|
202
214
|
|
|
203
215
|
### Controller
|
|
204
216
|
If you've decided to adapt this **Nestia** and you want to generate the SDK directly, you don't need any extra work. Just keep you controller class down and do noting. The only one exceptional case that you need an extra dedication is, when you want to explain about the API function to the client developers through the comments.
|
package/bin/executable/nestia.js
CHANGED
|
File without changes
|