{"id":15672667,"url":"https://github.com/cbornet/generator-jhipster-swagger-cli","last_synced_at":"2025-05-06T22:07:28.596Z","repository":{"id":57247606,"uuid":"50679300","full_name":"cbornet/generator-jhipster-swagger-cli","owner":"cbornet","description":"DEPRECATED - JHipster module to generate client code from an OpenAPI/Swagger definition","archived":false,"fork":false,"pushed_at":"2019-11-27T14:45:29.000Z","size":40579,"stargazers_count":15,"open_issues_count":7,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-06T22:07:17.606Z","etag":null,"topics":["jhipster","openapi","swagger","swaggerclient"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cbornet.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}},"created_at":"2016-01-29T17:39:32.000Z","updated_at":"2020-02-02T12:49:50.000Z","dependencies_parsed_at":"2022-08-24T16:51:12.067Z","dependency_job_id":null,"html_url":"https://github.com/cbornet/generator-jhipster-swagger-cli","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbornet%2Fgenerator-jhipster-swagger-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbornet%2Fgenerator-jhipster-swagger-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbornet%2Fgenerator-jhipster-swagger-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbornet%2Fgenerator-jhipster-swagger-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cbornet","download_url":"https://codeload.github.com/cbornet/generator-jhipster-swagger-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252776579,"owners_count":21802468,"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":["jhipster","openapi","swagger","swaggerclient"],"created_at":"2024-10-03T15:29:47.930Z","updated_at":"2025-05-06T22:07:28.559Z","avatar_url":"https://github.com/cbornet.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deprecation warning: from JHipster 6.3.0, this module has been integrated in the main generator and shall not be used anymore.\n\n# generator-jhipster-swagger-cli\n[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]\n\u003e JHipster module to generate client code from an OpenAPI/Swagger definition\n\n# Introduction\n\nThis is a [JHipster](http://jhipster.github.io/) module, that is meant to be used in a JHipster application.\n\nThis module generates client code using [Spring-Cloud FeignClients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign) in your JHipster app from an OpenAPI/Swagger definition.\n\nThe generated FeignClient can be used in both Monolithic and Micro-service applications.\n\nThis module works for JHipster v5+ apps.\nFor older JHipster version, use version 2.x of this module (branch [v2.x-JHipster2-3-4](https://github.com/cbornet/generator-jhipster-swagger-cli/tree/v2.x-JHipster2-3-4))\n\nThis module works with both Swagger v2 and OpenAPI v3 definitions.\n\n# Prerequisites\n\nAs this is a [JHipster](http://jhipster.github.io/) module, we expect you have JHipster and its related tools already installed:\n\n- [Installing JHipster](https://jhipster.github.io/installation.html)\n\n# Installation\n\nTo install this module:\n\n```bash\nnpm install -g generator-jhipster-swagger-cli\n```\n\nTo update this module:\n```bash\nnpm update -g generator-jhipster-swagger-cli\n```\n\n# Usage\nRun:\n```bash\nyo jhipster-swagger-cli\n```\nthen answer the questions.\nYou have the possibility to store a client configuration for future regeneration (eg. if there is an API update).\nIf you do so, next time you launch the module, you will have the choice to generate a new client or to reuse one or several stored configurations.\n\n## Use the generated back-end Spring-Cloud FeignClient code\n\n### Client configuration\n\nYou can configure the generated FeignClients directly from the application.yml.\n`RequestInterceptor` beans are generated from the OpenAPI `securitySchemes` and are only activated if relevant properties are set.\nIf the OpenAPI spec doesn't contain the `securitySchemes`, then you will need to configure the clients by yourself (see [spring-cloud doc](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign) for details.)\n\n#### Configuring basic auth\n\nThe basic auth RequestInterceptor is activated if `\u003cclientName\u003e.security.\u003csecurityName\u003e.username` is set.\n```yaml\npetstore:\n    security:\n        basicAuth:\n            username: admin\n            password: admin\n```\n\n#### Configuring API key auth\n\nThe API key RequestInterceptor is activated if `\u003cclientName\u003e.security.\u003csecurityName\u003e.key` is set.\n```yaml\npetstore:\n    security:\n        apiKey:\n            key: 12345\n```\n\n#### Configuring OAuth2\n\nThe OAuth2 RequestInterceptor is activated if `\u003cclientName\u003e.security.\u003csecurityName\u003e.key` is set.\nFor details on configuring OAuth2, see the [spring-security-oauth2 doc](http://projects.spring.io/spring-security-oauth/docs/oauth2.html#protected-resource-configuration).\n```yaml\npetstore:\n    security:\n        passwordOauth:\n            client-id: myClientId\n            client-secret: myClientSecret\n            username: myUsername\n            password: myPassword\n            scopes:\n            - read\n            - write\n```\n\n#### Configuring the remote URL\n\nThe remote URL will default to the one from the OpenAPI spec but can be changed with the `\u003cclientName\u003e.url` property.\n```yaml\npetstore:\n    url: http://petstore-uat.swagger.io/v2\n```\n\n#### Use Ribbon (w/wo Eureka)\n\nYou need to add spring-cloud-starter-ribbon to your pom.xml if needed.\nNote that it seems to cause an issue with form-login on monoliths so it is not done by this module.\nThen set `\u003ccliName\u003e.url` to blank.\n```yaml\npetstore:\n    url:\n    ribbon:\n        listOfServers: petstore1.swagger.io,petstore2.swagger.io\n```\n\n#### Advanced configuration\n\nIf the generated clients don't fit your needs because you want to use Hystrix fallbacks, change the Ribbon context path or use different Feign client configuration, then simply create your own FeignClient beans extending the generated xxxApi classes.\n\n### Calling API methods\n\nFor instance if you generated the [petstore](http://petstore.swagger.io) API, you can call the addPet method like this:\n```java\n@Inject\nprivate PetApiClient petApiClient;\n...\nPet myPet = new Pet();\npetApiClient.addPet(myPet);\n```\n\n# License\n\nApache-2.0 © [Christophe Bornet]\n\n[npm-image]: https://img.shields.io/npm/v/generator-jhipster-swagger-cli.svg\n[npm-url]: https://npmjs.org/package/generator-jhipster-swagger-cli\n[travis-image]: https://travis-ci.org/cbornet/generator-jhipster-swagger-cli.svg?branch=master\n[travis-url]: https://travis-ci.org/cbornet/generator-jhipster-swagger-cli\n[daviddm-image]: https://david-dm.org/cbornet/generator-jhipster-swagger-cli.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/cbornet/generator-jhipster-module\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbornet%2Fgenerator-jhipster-swagger-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcbornet%2Fgenerator-jhipster-swagger-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbornet%2Fgenerator-jhipster-swagger-cli/lists"}