add API mock feature

README.md

@@ -9,6 +9,7 @@ Gateway is a API gateway based on http. It works at 7 layer.
 * Routing based on URL
 * API aggregation(support url rewrite)
 * Validation
+* API Mock
 * Backend Server heath check
 * Use [fasthttp](https://github.com/valyala/fasthttp)
 * Admin WEBUI

cmd/admin/public/assets/js/api.js

@@ -79,6 +79,8 @@ function APICreateController($scope, $routeParams, $http, $location, $route) {
  $scope.newUrl = "";
  $scope.newDesc = "";
  $scope.newName = "";
+ $scope.newMock = {};
+ $scope.newMockContentType = "";
  $scope.newNodes = [];
 
 
@@ -120,6 +122,8 @@ function APICreateController($scope, $routeParams, $http, $location, $route) {
  "url": $scope.newUrl,
  "method": $scope.newMethod,
  "desc": $scope.newDesc,
+ "mock": $scope.newMock,
+ "mockContentType": $scope.newMockContentType,
  "nodes": $scope.newNodes,
  }
 

cmd/admin/public/html/api/list.html

@@ -20,6 +20,7 @@ <h1 class="page-header">API</h1>
  <th>Method</th>
  <th>Desc</th>
  <th>Dispatch Nodes</th>
+ <th>Mock</th>
  <th>Opts</th>
  </tr>
  </thead>
@@ -58,6 +59,9 @@ <h1 class="page-header">API</h1>
  </tbody>
  </table>
  </td>
+ <td>
+ {{api.mock | json}}
+ </td>
  <td>
  <button type="button" class="btn btn-success btn-sm" ng-click="delete(api.encodeURL, api.method)">Delete</button>
  </td>

cmd/admin/public/html/api/new.html

@@ -26,6 +26,11 @@
  <label for="desc">Desc</label>
  <textarea class="form-control" ng-model="newDesc" id="desc" rows="4"></textarea>
  </div>
+
+ <div class="form-group">
+ <label for="mock">Mock</label>
+ <textarea json-text class="form-control" ng-model="newMock" id="mock" rows="15"></textarea>
+ </div>
  </div>
 </div>
 
@@ -52,7 +57,6 @@
  <label for="validation">Validation</label>
  <textarea json-text class="form-control" ng-model="newValidation" id="validation" rows="15"></textarea>
  </div>
-
  <button type="button" class="btn btn-default" ng-click="addNode()">Add</button>
  </form>
  </div>
@@ -80,7 +84,7 @@
  <td>
  <input type="text" size="10" ng-model="n.rewrite" />
  </td>
- <td> 
+ <td>
  <textarea json-text class="form-control" ng-model="n.validations" rows="15"></textarea>
  </td>
  <td>

cmd/admin/public/html/api/update.html

@@ -27,6 +27,11 @@
  <label for="desc">Desc</label>
  <textarea class="form-control" ng-model="api.desc" id="desc" rows="4"></textarea>
  </div>
+
+ <div class="form-group">
+ <label for="mock">Mock</label>
+ <textarea json-text class="form-control" ng-model="api.mock" id="mock" rows="15"></textarea>
+ </div>
  </div>
 </div>
 
@@ -52,7 +57,6 @@
  <label for="validation">Validation</label>
  <textarea json-text class="form-control" ng-model="newValidation" id="validation" rows="15"></textarea>
  </div>
-
  <button type="button" class="btn btn-default" ng-click="addNode()">Add</button>
  </form>
  </div>

docs/api.md

@@ -3,9 +3,37 @@ API
 API is the core concept in gateway. You can use admin to manage your APIs. 
 
 # API fields
+* Name
+ The API Name
+
 * URL
  URL is a regex pattern for match request url. If a origin request url matches this value, proxy dispatch request to nodes which is defined in this api.
 
+* Method
+ API Http method, the request must match both URL and method. `*` is match all http method(GET,PUT,POST,DELETE)
+
+* Mock
+ A mock json configuration like this
+ ```json
+ {
+ "value": "{\"abc\":\"hello\"}",
+ "contentType": "application/json; charset=utf-8",
+ "headers": [
+ {
+ "name": "header1",
+ "value": "value1"
+ }
+ ],
+ "cookies": [
+ "test-c=1", // it's a set-cookie header string format
+ "test-c2=2" // it's a set-cookie header string format
+ ]
+}
+ ```
+ value is required, contentType, headers and cookies are optional.
+
+ Note. If proxy get any error(e.g. has no backend server, backend return a error code) by this API, proxy will use mock to response.
+
 * Nodes
  API nodes is a list infomation. Every Node has 4 attrbutes: cluster, attrbute name, rewrite. Proxy will dispatch origin request to these nodes, and wait for all response, than merge to response to client.
 

pkg/model/api.go

@@ -17,12 +17,27 @@ type Node struct {
  Validations []*Validation `json:"validations, omitempty"`
 }
 
+// Mock mock
+type Mock struct {
+ Value string `json:"value"`
+ ContentType string `json:"contentType, omitempty"`
+ Headers []*MockHeader `json:"headers, omitempty"`
+ Cookies []string `json:"cookies, omitempty"`
+ ParsedCookies []*fasthttp.Cookie `json:"-"`
+}
+
+// MockHeader header
+type MockHeader struct {
+ Name string `json:"name"`
+ Value string `json:"value"`
+}
+
 // API a api define
 type API struct {
  Name string `json:"name, omitempty"`
  URL string `json:"url"`
  Method string `json:"method"`
- Alias string  `json:"alias, omitempty"`
+ Mock  *Mock  `json:"mock, omitempty"`
  Nodes []*Node `json:"nodes"`
  Desc string `json:"desc, omitempty"`
  Pattern *regexp.Regexp `json:"-"`
@@ -32,6 +47,11 @@ type API struct {
 func UnMarshalAPI(data []byte) *API {
  v := &API{}
  json.Unmarshal(data, v)
+
+ if v.Mock != nil && v.Mock.Value == "" {
+ v.Mock = nil
+ }
+
  return v
 }
 
@@ -42,6 +62,10 @@ func UnMarshalAPIFromReader(r io.Reader) (*API, error) {
  decoder := json.NewDecoder(r)
  err := decoder.Decode(v)
 
+ if v.Mock != nil && v.Mock.Value == "" {
+ v.Mock = nil
+ }
+
  return v, err
 }
 
@@ -53,6 +77,50 @@ func NewAPI(url string, nodes []*Node) *API {
  }
 }
 
+// Parse parse
+func (a *API) Parse() {
+ a.Pattern = regexp.MustCompile(a.URL)
+ for _, n := range a.Nodes {
+ if nil != n.Validations {
+ for _, v := range n.Validations {
+ v.ParseValidation()
+ }
+ }
+ }
+
+ if nil != a.Mock && nil != a.Mock.Cookies && len(a.Mock.Cookies) > 0 {
+ a.Mock.ParsedCookies = make([]*fasthttp.Cookie, len(a.Mock.Cookies))
+ for index, c := range a.Mock.Cookies {
+ ck := &fasthttp.Cookie{}
+ ck.Parse(c)
+ a.Mock.ParsedCookies[index] = ck
+ }
+ }
+}
+
+// RenderMock dender mock response
+func (a *API) RenderMock(ctx *fasthttp.RequestCtx) {
+ if a.Mock == nil {
+ return
+ }
+
+ ctx.Response.Header.SetContentType(a.Mock.ContentType)
+
+ if a.Mock.Headers != nil && len(a.Mock.Headers) > 0 {
+ for _, header := range a.Mock.Headers {
+ ctx.Response.Header.Add(header.Name, header.Value)
+ }
+ }
+
+ if a.Mock.ParsedCookies != nil && len(a.Mock.ParsedCookies) > 0 {
+ for _, ck := range a.Mock.ParsedCookies {
+ ctx.Response.Header.SetCookie(ck)
+ }
+ }
+
+ ctx.WriteString(a.Mock.Value)
+}
+
 // Marshal marshal
 func (a *API) Marshal() []byte {
  v, _ := json.Marshal(a)
@@ -70,8 +138,3 @@ func (a *API) getNodeURL(req *fasthttp.Request, node *Node) string {
 func (a *API) matches(req *fasthttp.Request) bool {
  return (a.Method == "*" || strings.ToUpper(string(req.Header.Method())) == a.Method) && a.Pattern.Match(req.URI().RequestURI())
 }
-
-func (a *API) updateFrom(api *API) {
- a.URL = api.URL
- a.Nodes = api.Nodes
-}

pkg/model/mock.json

@@ -0,0 +1,14 @@
+{
+ "value": "{\"abc\":\"hello\"}",
+ "contentType": "application/json; charset=utf-8",
+ "headers": [
+ {
+ "name": "header1",
+ "value": "value1"
+ }
+ ],
+ "cookies": [
+ "test-c=1",
+ "test-c2=2"
+ ]
+}

pkg/model/ruletable.go

@@ -2,7 +2,6 @@ package model
 
 import (
  "errors"
- "regexp"
  "sync"
  "time"
 
@@ -172,14 +171,7 @@ func (r *RouteTable) AddNewAPI(api *API) error {
  return ErrAPIExists
  }
 
- api.Pattern = regexp.MustCompile(api.URL)
- for _, n := range api.Nodes {
- if nil != n.Validations {
- for _, v := range n.Validations {
- v.ParseValidation()
- }
- }
- }
+ api.Parse()
 
  r.apis[getAPIKey(api.URL, api.Method)] = api
 
@@ -193,21 +185,12 @@ func (r *RouteTable) UpdateAPI(api *API) error {
  r.rwLock.Lock()
  defer r.rwLock.Unlock()
 
- old, ok := r.apis[getAPIKey(api.URL, api.Method)]
-
- if !ok {
+ if _, ok := r.apis[getAPIKey(api.URL, api.Method)]; !ok {
  return ErrAPINotFound
  }
 
- old.updateFrom(api)
-
- for _, n := range old.Nodes {
- if nil != n.Validations {
- for _, v := range n.Validations {
- v.ParseValidation()
- }
- }
- }
+ r.apis[getAPIKey(api.URL, api.Method)] = api
+ api.Parse()
 
  log.Infof("API <%s-%s> updated", api.Method, api.URL)
 

proxy/proxy.go

@@ -24,8 +24,6 @@ var (
 )
 
 var (
- // HeaderContentType content-type header
- HeaderContentType = "Content-Type"
  // MergeContentType merge operation using content-type
  MergeContentType = "application/json; charset=utf-8"
  // MergeRemoveHeaders merge operation need to remove headers
@@ -109,6 +107,12 @@ func (p *Proxy) ReverseProxyHandler(ctx *fasthttp.RequestCtx) {
 
  for _, result := range results {
  if result.Err != nil {
+ if result.API.Mock != nil {
+ result.API.RenderMock(ctx)
+ result.Release()
+ return
+ }
+
  ctx.SetStatusCode(result.Code)
  result.Release()
  return
@@ -128,7 +132,7 @@ func (p *Proxy) ReverseProxyHandler(ctx *fasthttp.RequestCtx) {
  result.Res.Header.CopyTo(&ctx.Response.Header)
  }
 
- ctx.Response.Header.Add(HeaderContentType, MergeContentType)
+ ctx.Response.Header.SetContentType(MergeContentType)
  ctx.SetStatusCode(fasthttp.StatusOK)
 
  ctx.WriteString("{")