hasancode-api-docs 1.0.4 → 1.0.7
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 +5 -5
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -41,7 +41,7 @@ If you use TypeScript decorators, enable these in your `tsconfig.json`:
|
|
|
41
41
|
|
|
42
42
|
```ts
|
|
43
43
|
import express from "express";
|
|
44
|
-
import { ApiDoc, doc } from "api-docs";
|
|
44
|
+
import { ApiDoc, doc } from "hasancode-api-docs";
|
|
45
45
|
|
|
46
46
|
const app = express();
|
|
47
47
|
app.use(express.json());
|
|
@@ -82,7 +82,7 @@ app.listen(5000, () => {
|
|
|
82
82
|
This is the lightweight style (similar to `example/server.js`).
|
|
83
83
|
|
|
84
84
|
```ts
|
|
85
|
-
import { doc } from "api-docs";
|
|
85
|
+
import { doc } from "hasancode-api-docs";
|
|
86
86
|
|
|
87
87
|
doc({
|
|
88
88
|
method: "get",
|
|
@@ -120,7 +120,7 @@ doc({
|
|
|
120
120
|
This is the advanced object-schema style (similar to `example2/src/app.ts`).
|
|
121
121
|
|
|
122
122
|
```ts
|
|
123
|
-
import { doc } from "api-docs";
|
|
123
|
+
import { doc } from "hasancode-api-docs";
|
|
124
124
|
|
|
125
125
|
doc({
|
|
126
126
|
method: "patch",
|
|
@@ -219,7 +219,7 @@ import {
|
|
|
219
219
|
Description,
|
|
220
220
|
Tags,
|
|
221
221
|
Auth,
|
|
222
|
-
} from "api-docs";
|
|
222
|
+
} from "hasancode-api-docs";
|
|
223
223
|
|
|
224
224
|
class UserController {
|
|
225
225
|
@Tags("Users")
|
|
@@ -359,7 +359,7 @@ new ApiDoc({
|
|
|
359
359
|
Import and use `CODE_THEMES`:
|
|
360
360
|
|
|
361
361
|
```ts
|
|
362
|
-
import { CODE_THEMES } from "api-docs";
|
|
362
|
+
import { CODE_THEMES } from "hasancode-api-docs";
|
|
363
363
|
|
|
364
364
|
const apiDocs = new ApiDoc({
|
|
365
365
|
title: "My API",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hasancode-api-docs",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "A simple and easy to use API documentation generator for Express.js",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -16,6 +16,8 @@
|
|
|
16
16
|
],
|
|
17
17
|
"keywords": [
|
|
18
18
|
"api",
|
|
19
|
+
"api-doc",
|
|
20
|
+
"api-docs",
|
|
19
21
|
"documentation",
|
|
20
22
|
"express",
|
|
21
23
|
"typescript",
|
|
@@ -47,7 +49,7 @@
|
|
|
47
49
|
"reflect-metadata": "^0.2.2"
|
|
48
50
|
},
|
|
49
51
|
"peerDependencies": {
|
|
50
|
-
"express": "
|
|
52
|
+
"express": ">=4.0.0"
|
|
51
53
|
},
|
|
52
54
|
"engines": {
|
|
53
55
|
"node": ">=20.0.0"
|