Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-springboot
APItoolkit Spring Boot client SDK.
https://github.com/apitoolkit/apitoolkit-springboot
apitoolkit apitoolkit-sdk java spring-boot
Last synced: about 17 hours ago
JSON representation
APItoolkit Spring Boot client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-springboot
- Owner: apitoolkit
- License: mit
- Created: 2024-05-26T23:51:51.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T14:09:28.000Z (5 months ago)
- Last Synced: 2024-05-29T02:26:22.222Z (5 months ago)
- Topics: apitoolkit, apitoolkit-sdk, java, spring-boot
- Language: Java
- Homepage:
- Size: 32.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Springboot SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/java/springboot?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Springboot Java application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.
---
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
To install the SDK, kindly add the following dependency to your `pom.xml` file within the `` section like so:
```xml
io.apitoolkit.springboot
apitoolkit-springboot
1.0.6
```
## Configuration
First, add your APItoolkit API key to the `application.properties` file like so:
```sh
apitoolkit.apikey={ENTER_YOUR_API_KEY_HERE};
# Other configuation options
apitoolkit.debug=false
# ...
```
> [!NOTE]
>
> 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&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
Then, initialize the SDK like so:
```java
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
// Import APItoolkit annotation
import io.apitoolkit.springboot.annotations.EnableAPIToolkit;
import org.springframework.web.bind.annotation.*;
@SpringBootApplication
// Add APIToolkit custom annotation
@EnableAPIToolkit
@RestController
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@GetMapping("/greet/{name}")
public String getUser(@PathVariable String name) {
return "Hello, " + name;
}
}
```
> [!IMPORTANT]
>
> 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&utm_medium=github&utm_source=sdks_readme).
## Contributing and Help
To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:
- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-springboot/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
