{"id":22816639,"url":"https://github.com/steeltoeoss/initializrservice","last_synced_at":"2025-04-22T21:17:05.105Z","repository":{"id":42519645,"uuid":"269464143","full_name":"SteeltoeOSS/InitializrService","owner":"SteeltoeOSS","description":"Reference implementation of a Steeltoe Initializr Server project generator","archived":false,"fork":false,"pushed_at":"2025-03-03T17:01:18.000Z","size":469,"stargazers_count":5,"open_issues_count":10,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-22T21:16:57.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SteeltoeOSS.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}},"created_at":"2020-06-04T20:58:49.000Z","updated_at":"2025-03-03T17:01:19.000Z","dependencies_parsed_at":"2024-02-09T16:28:42.316Z","dependency_job_id":"f62dd292-4cc6-4676-8518-98250584c5d8","html_url":"https://github.com/SteeltoeOSS/InitializrService","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteeltoeOSS%2FInitializrService","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteeltoeOSS%2FInitializrService/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteeltoeOSS%2FInitializrService/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SteeltoeOSS%2FInitializrService/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SteeltoeOSS","download_url":"https://codeload.github.com/SteeltoeOSS/InitializrService/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250324706,"owners_count":21411946,"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":[],"created_at":"2024-12-12T14:08:12.426Z","updated_at":"2025-04-22T21:17:05.064Z","avatar_url":"https://github.com/SteeltoeOSS.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steeltoe InitializrService\n\nSteeltoe Initializr Service reference implementation\n\n## Using the Server\n\n_InitializrService_ provides 4 REST/HTTP endpoints:\n\n* `api/`\n* `api/about`\n* `api/config`\n* `api/project`\n\n### `api/`\n\n`api/` accepts GET requests ands returns an _InitializrAPI_ help document.\nThe document includes available parameters (and their defaults) and dependencies, as well as some CLI samples.\n\n```sh\n$ http -p b https://start.steeltoe.io/api/\n...\nThis service generates quickstart projects that can be easily customized.\nPossible customizations include a project's dependencies and .NET target framework.\n\nThe URI templates take a set of parameters to customize the result of a request.\n+-----------------+-----------------------+----------------------------+\n| Parameter       | Description           | Default value              |\n+-----------------+-----------------------+----------------------------+\n| name            | project name          | Sample                     |\n| applicationName | application name      | SampleApplication          |\n...\n```\n\n### `api/about`\n\n`api/about` accepts GET requests ands returns _InitialzrAPI_ \"About\" information.\n\n```sh\n$ http -p b https://start.steeltoe.io/api/about\n{\n    \"commit\": \"381bbd2a1e30d621ed6ad4a07790955447ffe468\",\n    \"name\": \"Steeltoe.InitializrService\",\n    \"url\": \"https://github.com/SteeltoeOSS/InitializrService/\",\n    \"vendor\": \"SteeltoeOSS/VMware\",\n    \"version\": \"0.8.0\"\n}\n```\n\n### `api/config`\n\n`api/config` accepts GET requests and returns _InitializrService_ configuration.\n\nThe returned document includes _all_ configuration.   Sub-endpoints are available allowing for more targeted responses.\n\n`api/config/projectMetadata` can be used by smart clients, such as [_InitializrWeb_](https://github.com/SteeltoeOSS/InitializrWeb), to assist in creating user interfaces.\n\nThe following endpoints can be used by CLI users to determine what project configuration options are available:\n\n* `api/config/archiveTypes`\n* `api/config/dependencies`\n* `api/config/dotNetFrameworks`\n* `api/config/dotNetTemplates`\n* `api/config/languages`\n* `api/config/steeltoeVersions`\n\n```sh\n# sample: list available Steeltoe versions\n$ http -p b https://start.steeltoe.io/api/config/steeltoeVersions\n[\n    {\n        \"id\": \"2.4.4\",\n        \"name\": \"Steeltoe 2.4.4 Maintenance Release\"\n    },\n    {\n        \"id\": \"2.5.1\",\n        \"name\": \"Steeltoe 2.5.1 Maintenance Release\"\n    },\n    {\n        \"id\": \"3.0.1\",\n        \"name\": \"Steeltoe 3.0.1 Maintenance Release\"\n    }\n]\n\n# sample: list available dependency IDs\n$ http https://start.steeltoe.io/api/config/dependencies | jq '.[] .values[] .id' | sort\n\"actuator\"\n\"amqp\"\n\"azure-spring-cloud\"\n\"circuit-breaker\"\n\"cloud-foundry\"\n\"config-server\"\n\"data-mongodb\"\n\"data-redis\"\n\"docker\"\n\"dynamic-logger\"\n\"eureka-client\"\n\"mysql\"\n\"mysql-efcore\"\n\"oauth\"\n\"placeholder\"\n\"postgresql\"\n\"postgresql-efcore\"\n\"random-value\"\n\"sqlserver\"\n```\n\n### `api/project`\n\n`api/project` accepts GET and POST requests and returns a project as an archive.\n\nProjects are configured by using HTTP parameters, such as `name` for project name and `steeltoeVersion` for Steeltoe version.\nThe parameter `dependencies` is a little different than other parameters in that it is set to a comma-separated list of dependency IDs.\n\nTo get a list of parameters and dependencies, send a GET request to `api/`.\n\n```sh\n# sample: generate a .NET Core App 3.1 project with a actuator endpoints and a Redis backend:\n$ http https://start.steeltoe.io/api/project dotNetFramework=netcoreapp3.1 dependencies==actuators,redis -d\n```\n\n## Configuring the Server\n\nThe Initializr API configuration is a JSON document provided by a [Spring Cloud Config Server](https://cloud.spring.io/spring-cloud-config/multi/multi__spring_cloud_config_server.html) or a local file.\nThe former is recommended for production deployments; the latter is intended primarily for local development.\n\n### Using Spring Cloud Config Server\n\nThe Initializr API uses the [Steeltoe Config Server Provider](https://docs.steeltoe.io/api/v3/configuration/config-server-provider.html) to get configuration from a Spring Cloud Config Server.\n\nThe _InitializrAPI_ running at \u003chttps://start.steeltoe.io/api/\u003e uses a Spring Cloud Config Server backended at \u003chttps://github.com/SteeltoeOSS/InitializrConfig\u003e.\nThe following `appsettings.json` sample snippet is part of the _InitializrService_'s configuration:\n\n```json\n  ...,\n  \"spring\": {\n    \"application\": {\n      \"name\": \"SteeltoeInitializr\"\n    },\n    \"cloud\": {\n      \"config\": {\n        \"uri\": \"http://initializr-config-server/\"\n      }\n    }\n  },\n  ...\n```\n\n\nSee the Steeltoe Config Server Provider documentation for other configuration options.\n\n### Using a local file\n\n_**Note**_: configuring a local file overrides any Spring Cloud Config Server configuration\n\nThe following `appsettings.json` sample snippet configures the use of a local configuration file:\n\n```json\n  ...,\n  \"Initializr\": {\n    \"Configuration\" : {\n      \"Path\": \"Resources/config.json\"\n    }\n  },\n  ...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteeltoeoss%2Finitializrservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteeltoeoss%2Finitializrservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteeltoeoss%2Finitializrservice/lists"}