1. Tech

Built in 100% Kotlin and using Akka-Http and the Slate Components and Utilities.

2. Approach

Follows a philosophy of "protocol independent modular APIs" where you embed regular Kotlin classes as APIs to run in the server and/or in the CLI. Our server code marshalls/routes WEB API calls to your APIs. You can optionally annotate your APIs to make more descriptive and configurable.

APIS

The server is a container for your existing APIs. For more information see the APIs page

3. Examples

There are multiple examples of using the server to host Web APIS.

4. Setup

You can configure your Slate Server with the environment, other startup info, and APIs you want "embedded", and you are ready to have the server handle REST api calls. You can configure the port, environment, logs, and other settings in application.conf.

 
    // 1: Sample API ( Pure Kotlin annotated classes / methods 
    @Api(area = "app", name = "tests", verb = "*", protocol = "*")
    class SampleApi(context: AppContext): ApiBase(context) {
    
        @ApiAction(desc = "simple greeting", roles = "@parent", verb = "@parent", protocol = "@parent")
        fun hello(greeting: String): String {
            return "$greeting back"
        }
        
    }
	
	
    // 2: Setup the server with API(s)
    val server = Server(
            port = 5000,
            prefix = "/api/",
            info = true,
            ctx = AppContext.simple("myapp1"),
            apis = listOf(
                    ApiReg(SampleApi(ctx), false)
            )
    ) 

    // 3: Run the Server
    server.run()

5. Options

There are various options for configuring the server, with more options coming later.

6. Routing

The server routes WEB API calls to the classes and methods annotated to be publically accessible in your registered APIs. To simplify marshalling calls to your APIs, we have standardized routing conventions. In Slate Kit, you can easily access your apis via Web(http) or command line (CLI ) using a simple routing format. We call this the unified routing format. Refer to APIs for more info.

Example

 
 // 1. app.users.activate via Http GET ( query string )
 http://mycompany.com/api/app/users/activate?code=2&phone=123456789&active=true&email=kishore@abc.com
 
 
  // 2. app.users.activate via Http POST ( json data )
 http://mycompany.com/api/app/users/activate 
 { 
   code=2, phone=123456789, active=true, email="kishore@abc.com" 
 } 

 // 3. CLI: command line syntax
 // unified routing format: area.api.action -key=value*
 app.users.activate -code=2 -phone=123456789 -active=true -email="kishore@abc.com"
 

7. Discovery

Api discovery is simple with the unified routing formats. All the areas, apis inside areas, and actions inside apis can be easily discovered with the following syntax, and replacing the part with the word help.

Examples

Notes

8. Security

Security for the APIs is implemented by providing an implementation of the Auth interface to the Server. The APIs can be secured using either API-keys, roles based security and/or using your Auth implementation. The Auth implementation simply validates a Request.

Annotations

You can optionally annotate, classes and methods with roles and other attributes. The API guide contains more information on this functionality. See the API Security

Auth classes

There some interfaces, default implementations and samples of using and building your own auth implemenations. Refer to the sources below

9. More

There are many more features available. Refer to the API Guide for more info.

Back to top