@aetherionfw/docs 1.0.0 → 1.1.1
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 +33 -0
- package/package.json +7 -2
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @aetherionfw/docs
|
|
2
|
+
|
|
3
|
+
> OpenAPI generator and documentation UI for the Aetherion Serverless Framework.
|
|
4
|
+
|
|
5
|
+
Aetherion is a modern, TypeScript-first serverless framework designed to bring the developer experience of frameworks like NestJS to AWS serverless architectures.
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
This package automatically generates OpenAPI (Swagger) specifications by analyzing the `@Route` decorators in your Aetherion application. It also provides a local web server to view the documentation interactively using [Scalar](https://scalar.com/).
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @aetherionfw/docs
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
This package is typically invoked via the Aetherion CLI:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
aetherion docs --serve
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This will generate the `openapi.json` file and start a local server at `http://localhost:3000/docs` where you can explore your API endpoints.
|
|
26
|
+
|
|
27
|
+
## Documentation
|
|
28
|
+
|
|
29
|
+
For full documentation, visit [https://github.com/CrisD3v/Aetherion-framework](https://github.com/CrisD3v/Aetherion-framework).
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aetherionfw/docs",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "OpenAPI Documentation & Scalar for Aetherion Framework",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"dependencies": {
|
|
8
8
|
"express": "^4.19.0",
|
|
9
9
|
"reflect-metadata": "^0.2.2",
|
|
10
|
-
"@aetherionfw/core": "1.
|
|
10
|
+
"@aetherionfw/core": "1.1.1"
|
|
11
11
|
},
|
|
12
12
|
"devDependencies": {
|
|
13
13
|
"@types/express": "^4.17.21",
|
|
@@ -23,6 +23,11 @@
|
|
|
23
23
|
],
|
|
24
24
|
"author": "CrisD3v",
|
|
25
25
|
"license": "MIT",
|
|
26
|
+
"repository": {
|
|
27
|
+
"type": "git",
|
|
28
|
+
"url": "https://github.com/CrisD3v/Aetherion-framework.git",
|
|
29
|
+
"directory": "packages/docs"
|
|
30
|
+
},
|
|
26
31
|
"scripts": {
|
|
27
32
|
"build": "tsc",
|
|
28
33
|
"clean": "rm -rf dist"
|