The following section covers the components of Java frameworks and their library components that NightVision’s API Discovery capability can detect and use to generate OpenAPI documentation. If a component that you use is not supported, please get in touch with our support team at [email protected], and we can add this as a new feature.
| Library Component | Description |
|---|
| Generated (Java EE/Jakarta EE) | Used to mark source code that has been generated. |
| security.DenyAll (Java EE /Jakarta EE) | Specifies that no security roles are allowed to access the endpoint |
| security.PermitAll (Java EE /Jakarta EE) | Specifies that all security roles are allowed to access the endpoint |
| security.RolesAllowed (Java EE /Jakarta EE) | Specifies the list of security roles permitted to access endpoint |
| Library Component | Description |
|---|
| HttpServletRequest Java EE/Jakarta EE | Provides request information for HTTP servlets |
| HttpServletResponse Java EE /Jakarta EE | Specifies that no security roles are allowed to access the endpoint |
| Library Component | Description |
|---|
| MediaType | An abstraction for a media type |
| Context | Used to inject information into a class field, bean property or method parameter. |
| Library Component | Description |
|---|
| GET | Indicates that the annotated method responds to HTTP GET requests. |
| POST | Indicates that the annotated method responds to HTTP POST requests. |
| PUT | Indicates that the annotated method responds to HTTP PUT requests. |
| DELETE | Indicates that the annotated method responds to HTTP DELETE requests. |
| HEAD | Indicates that the annotated method responds to HTTP HEAD requests. |
| OPTIONS | Indicates that the annotated method responds to HTTP OPTIONS requests. |
| ApplicationPath | Identifies the application path that serves as the base URI for all resource URIs provided by Path. May only be applied to a subclass of Application. |
| Path | Identifies the URI path that a resource class or class method will serve requests for. |
| PathParam | Binds the value of a URI template parameter or a path segment containing the template parameter to a resource method parameter, resource class field, or resource class bean property. |
| QueryParam | Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property. |
| FormParam | Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter. |
| HttpMethod | Associates the name of a HTTP method with an annotation. |
NightVision supports the annotations below for classes, interfaces, methods and parameters.
| Library Component | Description |
|---|
| Controller | Indicates that an annotated class is a "Controller" (e.g. a web controller). |
| Library Component | Description |
|---|
| RequestMapping | Annotation for mapping web requests onto methods in request-handling classes with flexible method signatures. |
| RestController | A convenience annotation that is itself annotated with @Controller and @ResponseBody. |
| ResponseBody | Annotation that indicates a method return value should be bound to the web response body. Supported for annotated handler methods. |
| DeleteMapping | Annotation for mapping HTTP DELETE requests onto specific handler methods. |
| GetMapping | Annotation for mapping HTTP GET requests onto specific handler methods. |
| PatchMapping | Annotation for mapping HTTP PATCH requests onto specific handler methods. |
| PostMapping | Annotation for mapping HTTP POST requests onto specific handler methods. |
| PutMapping | Annotation for mapping HTTP PUT requests onto specific handler methods. |
| PathVariable | Annotation which indicates that a method parameter should be bound to a URI template variable. Supported for RequestMapping annotated handler methods. |
| Library Component | Description |
|---|
| RepositoryRestResource | Annotation marking a repository class to autogenerate routes and handlers for CRUD operations over that repository |
| RestResource | Annotation marking a Repository to influence how it is exported and what the routes will be links. |
| Library Component | Description |
|---|
| Body | Indicates that the method argument is bound from the HTTP body |
| Consumes | Indicates the MediaTypes consumed by a particular component |
| Controller | Indicates that the role of a class is a controller within an application |
| CookieValue | Indicates that the method argument is bound from an HTTP cookie |
| CustomHttpMethod | Indicates that the method receives a request with a non-standard method |
| Delete | Indicates that the method receives a DELETE request |
| Error | Maps a method to an error route |
| Get | Indicates that the method receives a GET request |
| Head | Indicates that the method receives a HEAD request |
| Header | Indicates that the method argument is bound from an HTTP header |
| Options | Indicates that the method receives an OPTIONS request |
| Part | Indicates that the method argument is bound from a specific part of a "multipart/form-data" request |
| Patch | Indicates that the method receives a PATCH request |
| PathVariable | Binds a parameter exclusively from a path variable |
| Post | Indicates that the method receives a POST request |
| Produces | Indicates the MediaTypes produced by a particular component |
| Put | Indicates that the method receives a PUT request |
| QueryValue | Binds a method parameter to a value in the query string or path of the URI |
| RequestAttribute | Indicates that a method argument is bound to an HTTP request attribute |
| RequestBean | Used to bind Bindable parameters to a Bean object |
| Status | Sets alternative HttpStatus response code when applied to a method |
| Trace | Indicates that the method receives a TRACE request |
