Golang实现MongoDB文档和元数据访问的REST服务插件库Mora的使用

Mora - Mongo Rest API

REST server for accessing MongoDB documents and meta data

Mora是一个基于Golang的REST服务插件库，用于访问MongoDB文档和元数据。

文档查询参数

在查询集合时，可以使用以下参数：

query  - 使用Mongo shell语法，例如 {"size":42}
limit  - 返回结果的最大文档数
skip   - 结果集的偏移量
fields - 逗号分隔的(路径点)字段名列表
sort   - 逗号分隔的(路径点)字段名列表
extended_json - 设置为"true"以MongoDB扩展JSON格式返回响应

使用示例

列出别名

$ curl 'http://127.0.0.1:8181/docs/' \
  -D - \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:06:30 GMT
Content-Length: 61

{
  "success": true,
  "data": [
   "test",
   "local"
  ]
}

列出数据库

$ curl 'http://127.0.0.1:8181/docs/local/' \
  -D - \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:07:11 GMT
Content-Length: 61

{
  "success": true,
  "data": [
   "local",
   "use1"
  ]
}

列出集合

$ curl 'http://127.0.0.1:8181/docs/local/local' \
  -D - \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:24:10 GMT
Content-Length: 98

{
  "success": true,
  "data": [
   "new-collection",
   "startup_log",
   "system.indexes"
  ]
}

插入文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection/document-id' \
-D - \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data '{"title": "Some title", "content": "document content"}'

HTTP/1.1 201 Created
Content-Location: /docs/local/local/new-collection/document-id
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:23:33 GMT
Content-Length: 116

{
  "success": true,
  "data": {
   "created": true,
   "url": "/docs/local/local/new-collection/document-id"
  }
}

查找文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection/document-id' \
  -D - \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:32:33 GMT
Content-Length: 123

{
  "success": true,
  "data": {
   "_id": "document-id",
   "content": "document content",
   "title": "Some title"
  }
}

查找多个文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection?limit=1&skip=1' \
   -D - \
   -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 23 Apr 2014 23:18:39 GMT
Content-Length: 387

{
  "success": true,
  "prev_url": "/docs/local/local/new-collection?limit=1&skip=0",
  "next_url": "/docs/local/local/new-collection?limit=1&skip=2",
  "data": [
   {
    "_id": "535849cfb734f91cdc000002",
    "content": "document content",
    "title": "Some title"
   }
  ]
}

更新文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection/document-id' \
  -D - \
  -X PUT \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  --data '{"title": "New title"}'
HTTP/1.1 200 OK
Content-Location: /docs/local/local/new-collection/document-id
Content-Type: application/json
Date: Tue, 22 Apr 2014 06:37:02 GMT
Content-Length: 133

{
  "success": true,
  "data": {
   "created": false,
   "url": "/docs/local/local/new-collection/document-id"
  }
}

更新多个文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection' \
  -D - \
  -X PUT \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  --data '{"$set": {"title": "New title"}}'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 23 Apr 2014 23:33:11 GMT
Content-Length: 22

{
  "success": true
}

删除文档

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection/document-id'  \
  -D - \
  -X DELETE \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:42:47 GMT
Content-Length: 22

{
  "success": true
}

删除集合

$ curl 'http://127.0.0.1:8181/docs/local/local/new-collection'  \
  -D - \
  -X DELETE \
  -H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 07:43:24 GMT
Content-Length: 22

{
  "success": true
}

统计信息

数据库统计

$ curl http://127.0.0.1:8181/stats/local/local -D -
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 08:17:46 GMT
Content-Length: 341

{
  "success": true,
  "data": {
   "avgObjSize": 595.6,
   "collections": 3,
   "dataFileVersion": {
    "major": 4,
    "minor": 5
   },
   "dataSize": 5956,
   "db": "local",
   "fileSize": 67108864,
   "indexSize": 0,
   "indexes": 0,
   "nsSizeMB": 16,
   "numExtents": 3,
   "objects": 10,
   "ok": 1,
   "storageSize": 10502144
  }
}

集合统计

$ curl http://127.0.0.1:8181/stats/local/local/startup_log -D -
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 08:18:16 GMT
Content-Length: 389

{
  "success": true,
  "data": {
   "avgObjSize": 728,
   "capped": true,
   "count": 8,
   "indexSizes": {},
   "lastExtentSize": 10485760,
   "max": 9223372036854775807,
   "nindexes": 0,
   "ns": "local.startup_log",
   "numExtents": 1,
   "ok": 1,
   "paddingFactor": 1,
   "size": 5824,
   "storageSize": 10485760,
   "systemFlags": 0,
   "totalIndexSize": 0,
   "userFlags": 0
  }
}

从源码安装

go get -u github.com/emicklei/mora

创建发布

sh release.sh

配置

Mora使用简单的属性文件来指定主机、端口、别名和其他选项。

# listener info is required
http.server.host=localhost
http.server.port=8181

# enable cross site requests
http.server.cors=true

# for swagger support (optional)
swagger.path=/apidocs/
swagger.file.path=./swagger-ui/dist

# mongo instances are listed here; specify an alias for each
mongod.{alias}.host=localhost
mongod.{alias}.port=27017
# initial and operational timeout in seconds
mongod.{alias}.timeout=5
# optional authentication
mongod.{alias}.username=
mongod.{alias}.password=
mongod.{alias}.database=
# read preference mode
# supported options (case-insensitive): https://godoc.org/gopkg.in/mgo.v2#Mode
mongod.{alias}.mode=primary
# alternatively, a mongodb connection string uri can be used instead
# supported options: https://godoc.org/gopkg.in/mgo.v2#Dial
mongod.{alias}.uri=mongodb://myuser:mypass@localhost:40001,otherhost:40001/mydb

# enable /stats/ endpoint
mora.statistics.enable=true

运行

$ mora -config mora.properties

Swagger

Swagger UI会自动显示API文档和测试界面。

© 2013, MIT License