forked from Hithomelabs/CFTunnels
[ISSUE-115] Fix JavaDoc standards and add javadoc verification #2
@ -3,11 +3,46 @@ package com.hithomelabs.CFTunnels;
|
|||||||
import org.springframework.boot.SpringApplication;
|
import org.springframework.boot.SpringApplication;
|
||||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main Spring Boot application class for Cloudflare Tunnels API.
|
||||||
|
*
|
||||||
|
* <p>This application provides a RESTful API for managing Cloudflare Tunnels,
|
||||||
|
* allowing users to create tunnel mappings to services with an approval workflow.</p>
|
||||||
|
*
|
||||||
|
* <p><b>Features:</b></p>
|
||||||
|
* <ul>
|
||||||
|
* <li>Create, update, and delete Cloudflare tunnels</li>
|
||||||
|
* <li>Add ingress mappings to tunnels</li>
|
||||||
|
* <li>Request/approval workflow for mapping changes</li>
|
||||||
|
* <li>OIDC-based authentication with role-based access</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p><b>Technology Stack:</b></p>
|
||||||
|
* <ul>
|
||||||
|
* <li>Java 17</li>
|
||||||
|
* <li>Spring Boot 3.x</li>
|
||||||
|
* <li>Spring Data JPA</li>
|
||||||
|
* <li>Spring Security with OIDC</li>
|
||||||
|
* <li>H2 Database (configurable for PostgreSQL)</li>
|
||||||
|
* <li>Cloudflare API</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p>Access the API documentation at:
|
||||||
|
* {@code /swagger-ui.html} for the Swagger/OpenAPI UI</p>
|
||||||
|
*
|
||||||
|
* @see <a href="https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-negative">Cloudflare Tunnel Documentation</a>
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
@SpringBootApplication
|
@SpringBootApplication
|
||||||
public class CfTunnelsApplication {
|
public class CfTunnelsApplication {
|
||||||
|
|
||||||
public static void main(String[] args) {
|
/**
|
||||||
SpringApplication.run(CfTunnelsApplication.class, args);
|
* Main entry point for the application.
|
||||||
}
|
*
|
||||||
|
* @param args command line arguments passed to the application
|
||||||
|
*/
|
||||||
|
public static void main(String[] args) {
|
||||||
|
SpringApplication.run(CfTunnelsApplication.class, args);
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user