{"id":15937620,"url":"https://github.com/geeklearningio/gl-swagger-generator","last_synced_at":"2025-03-25T07:30:54.238Z","repository":{"id":37693127,"uuid":"57334772","full_name":"geeklearningio/gl-swagger-generator","owner":"geeklearningio","description":"Jane - An OpenAPI Specification (formerly Swagger) Client Generator","archived":false,"fork":false,"pushed_at":"2022-06-22T05:48:37.000Z","size":615,"stargazers_count":6,"open_issues_count":33,"forks_count":1,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2024-10-08T05:03:54.871Z","etag":null,"topics":["handlebars","nodejs","swagger","swagger-codegen","swagger-generator"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geeklearningio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-28T21:26:32.000Z","updated_at":"2020-03-07T05:49:18.000Z","dependencies_parsed_at":"2022-09-15T11:41:35.821Z","dependency_job_id":null,"html_url":"https://github.com/geeklearningio/gl-swagger-generator","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geeklearningio%2Fgl-swagger-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geeklearningio%2Fgl-swagger-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geeklearningio%2Fgl-swagger-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geeklearningio%2Fgl-swagger-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geeklearningio","download_url":"https://codeload.github.com/geeklearningio/gl-swagger-generator/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222046258,"owners_count":16922065,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["handlebars","nodejs","swagger","swagger-codegen","swagger-generator"],"created_at":"2024-10-07T05:04:06.936Z","updated_at":"2024-10-29T12:35:03.406Z","avatar_url":"https://github.com/geeklearningio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jane - An OpenAPI Specification (formerly Swagger) Client Generator\n\nJane is an [OpenAPI Specification](https://www.openapis.org/) client generator. \nIt uses templates written in Handlebars to generate a client code base in various languages.\n\nThe initial release is focused on providing a strong support of C# .NET Standard 1.3 \nand TypeScript. \n\n# Basic usage\n\nTo generate the API client, you need to give it two things:\n- The *swagger json file* of your API, defining all the available methods.\n- A *configuration json file*, specifying some options for your client generation.\n\nA configuration file looks like this:\n```json\n{\n  \"language\": \"typescript\",\n  \"framework\": \"angular\",\n  \"version\": \"1.5\",\n  \"mode\": \"singleFile\",\n  \"dependencies\": {\n  },\n  \"mediaTypesPriorities\": {\n    \"application/json\": 1\n  },\n  \"ambientTypes\": [\n  ],\n  \"templateOptions\": {\n    \"clientName\": \"MyAPIClient\"\n    \"scheme\": {\n      \"override\": \"https\"\n    },\n    \"generateInterface\": true\n  }\n}\n```\n\nTo generate your API client, just run swaggen with these options:\n```bash\nswaggen --outputPath ./outputpath --options ./swaggen-config.json --schema ./api-swagger.json\n```\n\n## Languages available\nYou can generate the client in 2 languages for the moment. Here are the docs:\n- [C# .NET Standard](https://github.com/geeklearningio/gl-swagger-generator/wiki/Csharp-Net-Standard)\n- [TypeScript Angular 1.5](https://github.com/geeklearningio/gl-swagger-generator/wiki/Angular-1.5)\n\n# Documentation\n\nDocumentation is maintained in this repository [wiki](https://github.com/geeklearningio/gl-swagger-generator/wiki)\n\n# Integration\n\nJane will have a CLI interface but is meant to be integrated in build pipeline such as gulp. \nA gulp plugin acting as a wrapper for Jane is [already available](https://github.com/geeklearningio/gulp-swagger-generator/tree/develop).\nPlease check the [wiki](https://github.com/geeklearningio/gl-swagger-generator/wiki) for guidance.\n\n# Extensibility\n\nOne purpose of this generator is to allow you to write or customize templates if needed. Please check the wiki for more information.\n\n# The story behind this project\n\nRead the [Jane's story](https://github.com/geeklearningio/gl-swagger-generator/wiki/Jane's-story)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeeklearningio%2Fgl-swagger-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeeklearningio%2Fgl-swagger-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeeklearningio%2Fgl-swagger-generator/lists"}