{"id":16111769,"url":"https://github.com/cliffano/swaggy-c","last_synced_at":"2025-09-22T05:32:51.515Z","repository":{"id":66257565,"uuid":"88591855","full_name":"cliffano/swaggy-c","owner":"cliffano","description":"Builder for OpenAPIGenerator-generated API clients in multiple languages","archived":false,"fork":false,"pushed_at":"2024-11-02T00:22:13.000Z","size":592,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-12T06:02:49.734Z","etag":null,"topics":["makefile","openapi","openapi-generator"],"latest_commit_sha":null,"homepage":"","language":"Makefile","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/cliffano.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2017-04-18T06:49:50.000Z","updated_at":"2024-11-02T00:22:17.000Z","dependencies_parsed_at":"2024-01-07T07:28:05.181Z","dependency_job_id":"24e4b11f-1504-4115-8043-bd4a98a255a3","html_url":"https://github.com/cliffano/swaggy-c","commit_stats":{"total_commits":130,"total_committers":2,"mean_commits":65.0,"dds":"0.23076923076923073","last_synced_commit":"9c90ff302e808c558acf0114f687bc653ab6f7af"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Fswaggy-c","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Fswaggy-c/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Fswaggy-c/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Fswaggy-c/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cliffano","download_url":"https://codeload.github.com/cliffano/swaggy-c/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233828145,"owners_count":18736578,"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":["makefile","openapi","openapi-generator"],"created_at":"2024-10-09T19:45:28.701Z","updated_at":"2025-09-22T05:32:46.245Z","avatar_url":"https://github.com/cliffano.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg align=\"right\" src=\"https://raw.github.com/cliffano/swaggy-c/master/avatar.jpg\" alt=\"Avatar\"/\u003e\n\n[![Build Status](https://github.com/cliffano/swaggy-c/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/cliffano/swaggy-c/actions/workflows/ci-workflow.yaml)\n\u003cbr/\u003e\n\nSwaggy C\n--------\n\nSwaggy C is a builder for [OpenAPI Generator](https://openapi-generator.tech/)-generated API clients in multiple technology stacks.\n\nIt provides utility targets for generating the API clients, building, testing, and publishing the artifacts, from an OpenAPI spec in one go.\n\nHave a look at [Swaggy Jenkins](http://github.com/cliffano/swaggy-jenkins) as an example project that was built using Swaggy C.\n\nInstallation\n------------\n\n1. Copy `src/Makefile-swaggy-c` to be the `Makefile` of your project:\n    curl https://raw.githubusercontent.com/cliffano/swaggy-c/main/src/Makefile-swaggy-c -o Makefile\n2. Create configuration file `swaggy-c.yml` with properties described in [Configuration](#configuration) section\n3. Run the available `Makefile` targets described in [Usage](#usage) section\n\nConfiguration\n-------------\n\nCreate Swaggy C configuration file called `swaggy-c.yml` with contains the following properties:\n\n| Property | Description | Example |\n|----------|-------------|---------|\n| spec_uri | File path or URL where the OpenAPI specification is located | `spec/some-app.yaml` or `https://some-app.com/some-app.yaml` |\n| version | Version of the application using Swaggy C | `1.2.3` |\n| contact.name | Contact name to be amended to the OpenAPI specification | `John Citizen` |\n| contact.url | Contact URL to be amended to the OpenAPI specification | `https://some-app.com` |\n| contact.email | Contact email to be amended to the OpenAPI specification | `johnc@some-app.com` |\n| scm.git_user | Git user/org name to be amended to the generated  OpenAPI Generator configuration | `johncitizen` |\n| scm.git_repo | Git repo name to be amended to the generated OpenAPI Generator configuration | `some-app` |\n| base_dir.github_actions | Absolute path where the application base directory is located within GitHub Actions runner, use this by setting GITHUB_ACTIONS environment variable | `/home/runner/work/some-app/some-app` |\n| base_dir.local | Absolute path where the application base directory is located within your local environment, use this when no environment variable specified | `/Users/some-user/some-path/some-app` |\n| base_dir.custom | Absolute path where the application base directory is any custom directory, use this by setting CUSTOM environment variable | `/Users/some-user/some-path/some-app` |\n\nUsage\n-----\n\nThe following targets are available:\n\n| Target | Description |\n|--------|-------------|\n| ci | CI target to be executed by CI/CD tool |\n| stage | Ensure stage directory exists |\n| clean | Remove all generated API clients code |\n| deps | Retrieve the OpenAPI Generator Docker image and npm modules |\n| init-spec | Initialise OpenAPI specification from either a local file path or a remote URL |\n| init-langs-config | Initialise empty configuration file for all languages |\n| update-to-latest | Update Makefile to the latest version on origin's main branch |\n| update-to-version | Update Makefile to the version defined in TARGET_SWAGGY_C_VERSION parameter |\n| generate | Alias for generate-all target |\n| generate-all | Generate API clients for all languages, this is separate from generate-primary target in order to reduce the build time when processing primary languages |\n| generate-primary | Generate API clients for primary languages only |\n| build-\u003clang\u003e | API clients building targets for primary languages |\n| test-\u003clang\u003e | API clients testing targets for primary languages |\n| publish-\u003clang\u003e | API clients package publishing targets for primary languages |\n| doc | Alias for doc-latest target |\n| doc-latest | Generate API documentation locally as the latest version |\n| doc-version | Generate API documentation locally as the application's version |\n| doc-publish | Publish documentation via GitHub Pages |\n\nUpgrade Guide\n-------------\n\nTo 4.x.x:\n\n* Revert all references of python-nextgen to python\n\nTo 2.x.x:\n\n* Copy clients/python/conf.json to clients/python-nextgen/conf.json\n* Rename all references of python to python-nextgen in GitHub Actions assets\n\nColophon\n--------\n\nRelated Project:\n\n* [OpenAPI Clients Factory](https://github.com/oapicf) - A project to produce OpenAPI-based clients using OpenAPI Generator\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffano%2Fswaggy-c","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcliffano%2Fswaggy-c","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffano%2Fswaggy-c/lists"}