Skip to content

Latest commit

 

History

History

FormsServer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Julia API server for FormsServer

Tests for different types of POST operations with forms and file uploads

Overview

This API server was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Build package: org.openapitools.codegen.languages.JuliaServerCodegen

Installation

Place the Julia files generated under the src folder in your Julia project. Include FormsServer.jl in the project code. It would include the module named FormsServer.

Implement the server methods as listed below. They are also documented with the FormsServer module. Launch a HTTP server with a router that has all handlers registered. A register method is provided in FormsServer module for convenience.

register(
    router::HTTP.Router,        # Router to register handlers in
    impl;                       # Module that implements the server methods
    path_prefix::String="",     # Prefix to be applied to all paths
    optional_middlewares...     # Optional middlewares to be applied to all handlers
)

Optional middlewares can be one or more of:

  • init: called before the request is processed
  • pre_validation: called after the request is parsed but before validation
  • pre_invoke: called after validation but before the handler is invoked
  • post_invoke: called after the handler is invoked but before the response is sent

The order in which middlewares are invoked are: init |> read |> pre_validation |> validate |> pre_invoke |> invoke |> post_invoke

API Endpoints

The following server methods must be implemented:

Class Method HTTP request Description
DefaultApi post_urlencoded_form POST /test/{form_id}/post_urlencoded_form_data posts a urlencoded form, with file contents and additional metadata, both of which are strings
DefaultApi upload_binary_file POST /test/{file_id}/upload_binary_file uploads a binary file given its path, along with some metadata
DefaultApi upload_text_file POST /test/{file_id}/upload_text_file uploads text file contents along with some metadata

Models

Author