Skip to main content

Find Spring API endpoints

org.openrewrite.java.spring.search.FindApiEndpoints

Find all HTTP API endpoints exposed by Spring applications. More specifically, this marks method declarations annotated with @RequestMapping, @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, and @PatchMapping as search results.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Examples​

Example 1​
Before​
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
class PersonController {
    @GetMapping("/count")
    int count() {
      return 42;
    }
}
After​
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
class PersonController {
    /*~~(GET /count)~~>*/@GetMapping("/count")
    int count() {
      return 42;
    }
}
Example 2​
Before​
import org.springframework.web.bind.annotation.*;

@RequestMapping("/person")
class PersonController {
    @GetMapping("/count")
    int count() {
      return 42;
    }
}
After​
import org.springframework.web.bind.annotation.*;

@RequestMapping("/person")
class PersonController {
    /*~~(GET /person/count)~~>*/@GetMapping("/count")
    int count() {
      return 42;
    }
}

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.7.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.spring.search.FindApiEndpoints")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:6.8.2")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

API endpoints​

org.openrewrite.java.spring.table.ApiEndpoints

The API endpoints that applications expose.

Column NameDescription
Source pathThe path to the source file containing the API endpoint definition.
Method SignatureThe method signature of the API endpoint.
Method nameThe name of the method that defines the API endpoint.
MethodThe HTTP method of the API endpoint.
PathThe path of the API endpoint.
Leading AnnotationsThe Leading annotations of the API endpoint.

Contributors​

Jonathan Schneider, Sam Snyder, Adrien Loison, Knut Wannheden