@elysiajs/openapi 1.3.2

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 saltyAom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# @elysiajs/openapi
+Plugin for [elysia](https://github.com/elysiajs/elysia) to auto-generate API documentation page.
+
+## Installation
+```bash
+bun add @elysiajs/openapi
+```
+
+## Example
+```typescript
+import { Elysia, t } from 'elysia'
+import { openapi } from '@elysiajs/openapi'
+
+const app = new Elysia()
+    .use(openapi())
+    .get('/', () => 'hi', { response: t.String({ description: 'sample description' }) })
+    .post(
+        '/json/:id',
+        ({ body, params: { id }, query: { name } }) => ({
+            ...body,
+            id,
+            name
+        }),
+        {
+            params: t.Object({
+                id: t.String()
+            }),
+            query: t.Object({
+                name: t.String()
+            }),
+            body: t.Object({
+                username: t.String(),
+                password: t.String()
+            }),
+            response: t.Object({
+                username: t.String(),
+                password: t.String(),
+                id: t.String(),
+                name: t.String()
+            }, { description: 'sample description' })
+        }
+    )
+    .listen(8080);
+```
+
+Then go to `http://localhost:8080/openapi`.
+
+# config
+
+## enabled
+@default true
+Enable/Disable the plugin
+
+## documentation
+OpenAPI documentation information
+
+@see https://spec.openapis.org/oas/v3.0.3.html
+
+## exclude
+Configuration to exclude paths or methods from documentation
+
+## exclude.methods
+List of methods to exclude from documentation
+
+## exclude.paths
+List of paths to exclude from documentation
+
+## exclude.staticFile
+@default true
+
+Exclude static file routes from documentation
+
+## exclude.tags
+List of tags to exclude from documentation
+
+## path
+@default '/openapi'
+
+The endpoint to expose OpenAPI documentation frontend
+
+## provider
+@default 'scalar'
+
+OpenAPI documentation frontend between:
+- [Scalar](https://github.com/scalar/scalar)
+- [SwaggerUI](https://github.com/openapi-api/openapi-ui)
+- null: disable frontend
+
+## references
+Additional OpenAPI reference for each endpoint
+
+## scalar
+Scalar configuration, refers to [Scalar config](https://github.com/scalar/scalar/blob/main/documentation/configuration.md)
+
+## specPath
+@default '/${path}/json'
+
+The endpoint to expose OpenAPI specification in JSON format
+
+## swagger
+Swagger config, refers to [Swagger config](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/)