Skip to content

An action for the Spring Endpoint Exporter that allows you to export all Endpoints of your Spring Boot Application in OpenAPI 3 format by scanning for specific classes in a jar file or on the file system without actually loading them.

License

Notifications You must be signed in to change notification settings

idealo/spring-endpoint-exporter-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spring Endpoint Exporter Action

This action allows you to use the spring-endpoint-exporter in you github workflows.

How to use the action?

- name: Export Spring Endpoints
  uses: idealo/[email protected]
  with:
    input-path: ./target/app.jar
    output-path: ./out.json
    include-filters: de.idealo.*

Inputs

Name Description Default value Required
scan-mode The mode the exporter will operate in. "JAR" No
input-path The jar or directory with class files to scan and export all request mappings from. null Yes
output-path Where to output the result of the exporter. null Yes
include-filters A set of packages to include when scanning for request mappings. null Yes
exclude-filters A set of packages to exclude when scanning for request mappings. null No

How to scan extracted jars or directories?

The action is able to search both jars and directories for class files and export all request mappings found. To scan directories, set scan-mode to FILE_SYSTEM and make sure that input-path points to the desired directory.

- name: Export Spring Endpoints
  uses: idealo/[email protected]
  with:
    scan-mode: FILE_SYSTEM
    input-path: ./target/
    output-path: ./out.json
    include-filters: de.idealo.*

About

An action for the Spring Endpoint Exporter that allows you to export all Endpoints of your Spring Boot Application in OpenAPI 3 format by scanning for specific classes in a jar file or on the file system without actually loading them.

Topics

Resources

License

Stars

Watchers

Forks