Public Endpoints

Create Endpoint

Endpoints in BeAPI are secure by default making most of them PRIVATE. To add an endpoint of your own, you need to follow these instructions:

• Add Your @Controller: create your controller using @Controller annotation and extend the BeapiRequestHandler:

  @Controller("company")
  public class CompanyController extends BeapiRequestHandler{
  
  	@Autowired
  	private CompanyService compService;
  
  	public Company show(HttpServletRequest request, HttpServletResponse response){
  		...
  	}

  
  
• Create/scaffold IO State file: You must then create an IO State file which contains all the rules for the endpoint. If you don't want to do this by hand, you can 'scaffold' it using the CLI tool:

  gradle  scaffold -Pargs="connector=<domain.package.name>"

Provided Endpoints

The Beapi Starter provides endpoints that are not visible in your project but can be called via API endpoints. These are also secured via IO State files (like all your other endpoints) but generally don't have to be changed. Below we go over each one of these and the endpoints provided...

curl -v -H "Content-Type: application/json" --data-binary @/home/owen/Desktop/User.json -H "Authorization: Bearer your-token-here" --request POST http://localhost:8080/v1.0/connector/update"