{"id":30110572,"url":"https://github.com/monoscope-tech/apitoolkit-springboot","last_synced_at":"2025-08-10T04:47:49.789Z","repository":{"id":241301658,"uuid":"806310119","full_name":"monoscope-tech/apitoolkit-springboot","owner":"monoscope-tech","description":"APItoolkit Java Springboot Client SDK.","archived":false,"fork":false,"pushed_at":"2025-01-24T18:05:53.000Z","size":95,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-10T14:51:23.576Z","etag":null,"topics":["apitoolkit","apitoolkit-sdk","java","spring-boot"],"latest_commit_sha":null,"homepage":"https://apitoolkit.io/docs/sdks/java/springboot/","language":"Java","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/monoscope-tech.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":"2024-05-26T23:51:51.000Z","updated_at":"2025-01-24T18:05:57.000Z","dependencies_parsed_at":"2024-05-29T02:26:23.399Z","dependency_job_id":null,"html_url":"https://github.com/monoscope-tech/apitoolkit-springboot","commit_stats":null,"previous_names":["apitoolkit/apitoolkit-spring","apitoolkit/apitoolkit-springboot","monoscope-tech/apitoolkit-springboot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/monoscope-tech/apitoolkit-springboot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monoscope-tech%2Fapitoolkit-springboot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monoscope-tech%2Fapitoolkit-springboot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monoscope-tech%2Fapitoolkit-springboot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monoscope-tech%2Fapitoolkit-springboot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/monoscope-tech","download_url":"https://codeload.github.com/monoscope-tech/apitoolkit-springboot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monoscope-tech%2Fapitoolkit-springboot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269677557,"owners_count":24457861,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["apitoolkit","apitoolkit-sdk","java","spring-boot"],"created_at":"2025-08-10T04:47:37.923Z","updated_at":"2025-08-10T04:47:49.757Z","avatar_url":"https://github.com/monoscope-tech.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)\n\n## Springboot SDK\n\n[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=spring)](https://github.com/topics/apitoolkit-sdk) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/java/springboot?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme)\n\nAPIToolkit Springboot SKD is a middleware that can be used to monitor HTTP requests. It is provides additional functionalities on top of the open telemetry instrumentation which creates a custom span for each request capturing details about the request including request and response bodies.\n\n\u003c/div\u003e\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Setup Open Telemetry](#setup-open-telemetry)\n- [APItoolkit SDK Configuration](#apitoolkit-sdk-configuration)\n- [Contributing and Help](#contributing-and-help)\n- [License](#license)\n\n---\n\n## Installation\n\nTo install the SDK, kindly add the following dependency to your `pom.xml` file within the `\u003cdependencies\u003e` section like so:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.apitoolkit.springboot\u003c/groupId\u003e\n    \u003cartifactId\u003eapitoolkit-springboot\u003c/artifactId\u003e\n    \u003cversion\u003e2.0.9\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Setup Open Telemetry\n\nSetting up open telemetry allows you to send traces, metrics and logs to the APIToolkit platform.\nTo setup open telemetry, you need to install the opentelemetry-javaagent.jar file.\n\n```sh\ncurl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar\n```\n\n### Setup Open Telemetry Variables\n\nThe environment variables include your API key and the endpoint to send the data to, this allows you to send data to the APIToolkit platform.\n\n```sh\nexport OTEL_EXPORTER_OTLP_ENDPOINT=\"http://otelcol.apitoolkit.io:4317\"\nexport OTEL_SERVICE_NAME=\"my-service\" # Specifies the name of the service.\nexport OTEL_RESOURCE_ATTRIBUTES=at-project-key=\"{ENTER_YOUR_API_KEY_HERE}\" # Adds your API KEY to the resource.\nexport OTEL_EXPORTER_OTLP_PROTOCOL=\"grpc\" #Specifies the protocol to use for the OpenTelemetry exporter.\n```\n\n\u003e [!NOTE]\n\u003e\n\u003e The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) generated from the APItoolkit dashboard.\n\n\u003cbr /\u003e\n\nYou can then run the application with opentelemetry instrumented using the following command:\n\n```sh\njava -javaagent:\u003cPATH-TO\u003e/opentelemetry-javaagent.jar -jar target/your_app.jar\n```\n\n## APItoolkit SDK Configuration\n\nThe apitoolkit sdk can be configured using the following optional properties:\n\n```sh\napitoolkit.captureRequestBody=true\napitoolkit.captureResponseBody=true\napitoolkit.serviceName=my-service\n\n# ...\n```\n\nThen, initialize the SDK like so:\n\n```java\npackage com.example.demo;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\n// Import APItoolkit annotation\nimport io.apitoolkit.springboot.annotations.EnableAPIToolkit;\nimport org.springframework.web.bind.annotation.*;\n\n@SpringBootApplication\n// Add APIToolkit custom annotation\n@EnableAPIToolkit\n@RestController\npublic class DemoApplication {\n\n\tpublic static void main(String[] args) {\n\t\tSpringApplication.run(DemoApplication.class, args);\n\t}\n\t@GetMapping(\"/greet/{name}\")\n\tpublic String getUser(@PathVariable String name) {\n\t\treturn \"Hello, \" + name;\n\t}\n}\n```\n\n\u003cbr /\u003e\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/java/springboot?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme).\n\n## Contributing and Help\n\nTo contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:\n\n- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).\n- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme).\n- Create a [new issue](https://github.com/apitoolkit/apitoolkit-springboot/issues/new/choose) in this repository.\n\n## License\n\nThis repository is published under the [MIT](LICENSE) license.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://apitoolkit.io?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true\" width=\"40\" /\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonoscope-tech%2Fapitoolkit-springboot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmonoscope-tech%2Fapitoolkit-springboot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonoscope-tech%2Fapitoolkit-springboot/lists"}