jsona-openapi 0.3.0

A openapi dsl in jsona
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

{
  @jsonaschema("openapi")
  @openapi({
    openapi: "3.0.0",
    info: {
      title: "Sample Api",
      describe: "Optional",
      version: "0.1.9"
    },
    servers: [
      {
        url: "http://localhost:3000"
      }
    ],
    security: [
      {
        jwt: []
      }
    ],
    components: {
      securitySchemes: {
        jwt: {
          type: "http",
          scheme: "bearer",
          bearerFormat: "JWT"
        }
      }
    }
  })
  endpoint1: { @endpoint({summary:"full spec"})
    route: "POST /a/{}/c/{}",
    req: {
      params: {
        b: "a",
        d: 3
      },
      headers: {
        'X-App-Key': 'Bearer Axxx...' @describe("x header")
      },
      query: {
        kind: 'q' @optional
      },
      body: { @describe("default content-type application/json")
        null: null,
        bool: false,
        integer: 3, @optional
        float: 4.3,
        array1: [ @describe("a simple array")
          '3'
        ],
        object1: { @def("object1")
          a: 3,
          b: 4
        },
        objectarray: [ @schema({maxItems:3})
          {
            a: 3
          }
        ],
        time: '2018-11-13T20:20:39Z' @schema({format:"date-time"})
      }
    },
    res: {
      200: { @describe("success response")
        bool: false,
        integer: 3,
        float: 4.3,
        array1: [
          '3'
        ],
        object1: {
          a: 3,
          b: 4
        },
        object2: { @ref("object1")
        }
      },
      400: {
        code: "ErrNoModel",
        message: "no model"
      }
    }
  },
  endpoint2: { @endpoint({summary:"no req and res"})
    route: "GET /endpoint2"
  },
  endpoint3: { @endpoint({summary:"custom content-type"})
    route: "POST /endpoint3",
    req: {
      body: "" @contentType("applicaton/xml")
    },
    res: {
      200: "" @contentType("applicaton/xml")
    }
  },
  endpoint4: { @endpoint({summary:"custom response header"})
    route: "GET /endpoint4",
    res: {
      200: { @withHeader
        headers: {
          'X-RateLimit': 10
        },
        body: {
        }
      }
    }
  },
  endpoint5: { @endpoint({summary:"operation x-*","x-swagger-router-controller":"OrderController"})
    route: "GET /endpoint6"
  }
}