{"id":22039299,"url":"https://github.com/grandlinex/swagger-mate","last_synced_at":"2026-04-15T18:31:21.363Z","repository":{"id":179254798,"uuid":"655675985","full_name":"GrandlineX/swagger-mate","owner":"GrandlineX","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-18T03:22:24.000Z","size":2163,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-18T07:09:29.805Z","etag":null,"topics":["api","grandlinex","openapi","openapi3","rest-api","swagger","swagger-ui","typescript"],"latest_commit_sha":null,"homepage":"https://www.grandlinex.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GrandlineX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-19T11:21:42.000Z","updated_at":"2026-01-18T03:21:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"3412638e-c902-487e-93cf-4d053ef0c534","html_url":"https://github.com/GrandlineX/swagger-mate","commit_stats":null,"previous_names":["grandlinex/swagger-mate"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/GrandlineX/swagger-mate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GrandlineX%2Fswagger-mate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GrandlineX%2Fswagger-mate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GrandlineX%2Fswagger-mate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GrandlineX%2Fswagger-mate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GrandlineX","download_url":"https://codeload.github.com/GrandlineX/swagger-mate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GrandlineX%2Fswagger-mate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31854625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","grandlinex","openapi","openapi3","rest-api","swagger","swagger-ui","typescript"],"created_at":"2024-11-30T11:10:13.561Z","updated_at":"2026-04-15T18:31:21.333Z","avatar_url":"https://github.com/GrandlineX.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger-Mate\n\u003e GrandLineX Swagger-Mate  project\n\n[![GitHub](https://badge.fury.io/gh/grandlinex%2Fswagger-mate.svg)](https://github.com/GrandlineX/swagger-mate)\n[![NPM](https://img.shields.io/static/v1?label=NPM\u0026message=Package\u0026color=red\u0026logo=NPM)](https://www.npmjs.com/package/@grandlinex/swagger-mate)\n![TS](https://img.shields.io/static/v1?label=Language\u0026message=TypeScript\u0026color=blue\u0026logo=TypeScript)\n\n### Status\n![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=alert_status)\n![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=security_rating)\n![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=sqale_rating)\n![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=reliability_rating)\n![Coverage](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=coverage)\n\n### Issues\n![Bugs](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=bugs)\n![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=vulnerabilities)\n![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=GrandlineX_swagger-mate\u0026metric=code_smells)\n\n## Features\n\n- Generate swagger.{json|yml} from code\n- Generate Api client from swagger.{json|yml}\n\n\n## Quick Start\n\n### Install\n\n1. Insatal npm package\n```shell\n  npm i  @grandlinex/swagger-mate\n```\n\n2. Update package.json \n```json\n{\n  //...\n  \"scripts\": {\n    \"makeSpec\": \"swagger-mate\",\n    \"serveSpec\": \"swagger-mate --serve\",\n    \"buildSpecMain\": \"swagger-mate --build --main\",\n    \"buildSpecDev\": \"swagger-mate --build --dev\"\n  },\n  \"glx\": {\n    \"kernel\": \"dist/Kernel.js\"\n  }\n  //...\n}\n```\n\n|Command| Description                                                                       |\n|---|-----------------------------------------------------------------------------------|\n|`npm run makeSpec`| make `openapi.json`                                                               |\n|`npm run serveSpec`| serve `openapi.json` with [swagger-ui](https://github.com/swagger-api/swagger-ui) |\n|`npm run buildSpecMain`| build api client (prod)                                                           |\n|`npm run buildSpecDev`| build api client (dev)                                                           |\n\n### Serve option\n\n\u003e Default port = 9000\n\nENV variables\n\n| ENV | Description              |\n|-----|--------------------------|\n|  SW_PORT   | set custom serve port    |\n|  SW_AUTH   | set default bearer token |\n\n## Define types\n\n### Kernel\n\n```typescript\nimport { SPathUtil, Swagger } from '@grandlinex/swagger-mate';\n// OpenApi 3.0.3 - Root Api definition\n@Swagger({\n  info: {\n    title: 'KernelTest',\n    version: '0.1.0', // Version (optional) will be read from package.json\n  },\n  openapi: '3.0.3',\n  servers: [\n    {\n      url: 'http://localhost:9257',\n      description: 'LocalDev',\n    },\n  ],\n  paths: {\n      // Static definition\n    '/version': {\n      get: {\n        description: 'Get version',\n        operationId: 'getVersion',\n        responses: SPathUtil.defaultResponse('200', '500'),\n      },\n    },\n   // Dynamic definition will be read from @SPath\n  },\n  security: [\n    {\n      bearerAuth: [],\n    },\n  ],\n  components: {\n    securitySchemes: {\n      bearerAuth: {\n        type: 'http',\n        scheme: 'bearer',\n        bearerFormat: 'JWT',\n      },\n    },\n  },\n})\nexport default class SomeKernel {}\n\n```\n\n### Action\n\n```typescript\nimport { SPathUtil, Swagger } from '@grandlinex/swagger-mate';\n\n// OpenApi 3.0.3 - Patch definition\n@SPath({\n    '/test': {\n        get: {\n            description: 'test',\n            operationId: 'getTest', // name for the js api client\n            summary: 'Descritption summary',\n            responses: SPathUtil.defaultResponse('200','400', '500')\n        },\n    },\n})\nexport default class SomeBaseApiAction {}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrandlinex%2Fswagger-mate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrandlinex%2Fswagger-mate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrandlinex%2Fswagger-mate/lists"}