Overview

• Motive
• How Microbuilder works

• Documentation and other links

  • json-stream-core
  • microbuilder-core
  • microbuilder-js
  • microbuilder-play

Microbuilder Interface Definition Language

• Concepts

• Interface definition

  • Package and directory layout
  • Interfaces and methods

• JSON schema

  • Request content JSON schema
  • Response content JSON schema

  • Built-in types for JSON schema

    • Primary types
    • Array types
  • Custom class types

• Annotations

  • @:structuralFailure
  • @:nativeGen
  • @:route
  • @:requestContentType
  • @:responseContentType
  • @:requestHeader
  • @:final
  • @:transient
  • @:jsonFieldName

Client-side SDKs

• For Scala client

  • Requirement

  • Create the SDK

    • Sbt configuration for SDK
    • MIDL API definition
    • MIDL JSON schema definition
  • Publish the SDK
  • Setup a Play project
  • Add SDK dependencies
  • Use the SDK
  • Other Play configurations
  • Initialize the SDK

• For JavaScript client

  • Requirement

  • Create the SDK

    • Sbt configuration for SDK
    • MIDL API definition
    • MIDL JSON schema definition
  • Publish the SDK
  • Setup your static web project
  • Add SDK dependencies
  • The web page
  • Initialize the SDK
  • Use the SDK

• For Haxe client

  • Requirement

  • Create the SDK

    • Sbt configuration for SDK
    • MIDL API definition
    • MIDL JSON schema definition

  • Publish the SDK to Haxelib

    • Setup a command-line program
    • The source file of the command-line program

• For other language client

  • Requirement

  • Create the SDK

    • Sbt configuration for SDK
    • MIDL API definition
    • MIDL JSON schema definition

  • Build SWC libraries

    • github-sdk.swc
    • microbuilder-core.swc

  • Create the Flash application

    • Prepare SWC Libraries
    • Edit source file
    • Compile the Flash application

Server-side stubs

• For Scala server

  • Requirement

  • Create the BFF SDK

    • Sbt configuration for the BFF SDK
    • MIDL API definition
    • MIDL JSON schema definition
  • Publish the SDK

  • Dependency settings for the BFF application

    • Setup a Play project
    • Add SDK dependencies
    • Implement the interfaces defined in BFF SDK
    • Configure Play framework to route to the service implementation
• For other language server

Generating Documentation

• Haxedoc

  • Requirement

  • Create the SDK

    • Sbt configuration for SDK
    • MIDL API definition
    • MIDL JSON schema definition
    • Generate Haxedoc
• Swagger UI