Route properties are meta data that can be associated to each route.

You can add them directly in the description of your route

service Employee{
    expose employees{
        route employee{
url:"employee/id:String"
response: EmployeeDTO
} } }

 

Standard Route properties :

  • label (String)
    • short description of the route
  • description (String)
    • description of the route
  • comment (String)
    • Allows you to add a comment to the route
  • urlExternalDescription (String)
    • url pointing to an external description of the route
  • url (String)
    • route (url of the route, usually with parameters. This url is automatically prefixed by the url of the service and the url of the resource in which this route has been declared)
    • read related article "How to declare url parameters"
  • method (String)
    • Http method to access the route (GET, PUT, POST, DELETE, PATCH)
  • intendMethod (String)
    • Action to perform (CREATE,READ,UPDATE,DELETE)
      • Allows to specify the action performed when calling this route if the http method is not precise enough to determine it
  • urlParams (String)
    • Name of the definition facade of the variable parameters of the url
      • Fields of this facade will added to variable parameters of the url (all fields must be scalar)
  • request (String)
    • scalar type name or valid facade name of the data model Akwatype
  • response (String)
    • scalar type name or valid facade name of the data model Akwatype
  • header (String)
    • scalar type name or valid facade name of the data model Akwatype
  • token (String)
    • scalar type name or valid facade name of the data model Akwatype
  • cookie (String)
    • scalar type name or valid facade name of the data model Akwatype
  • header (String)
    • scalar type name or valid facade name of the data model Akwatype

 

These properties are used by Akwatype during the different generations (Graphs, OpenAPI, Excel ...).

note : Premium plan allows you to create and use your own custom properties in addition to the standard akwatype properties.