docker-json-server, 基于普通 JSON,JSON服务器 Docker 映像,基于 REST API 模拟

分享于 

3分钟阅读

GitHub

  繁體 雙語
JSON Server docker image, REST API mocking based on plain JSON
  • 源代码名称:docker-json-server
  • 源代码网址:http://www.github.com/clue/docker-json-server
  • docker-json-server源代码文档
  • docker-json-server源代码下载
  • Git URL:
    git://www.github.com/clue/docker-json-server.git
    Git Clone代码到本地:
    git clone http://www.github.com/clue/docker-json-server
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/clue/docker-json-server
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    docker-json-server

    提供了基于普通JSON的mock。 这是一个 Docker 图像,简化了设置。

    用法

    这里 Docker 映像可以用作 Docker 索引上的信任构建,因此不需要安装。 首次使用这里图像将自动启动下载。 进一步运行将立即进行,因为图像将在本地缓存。

    运行这里容器的推荐方式如下所示:

    $ docker run -d -p 80:80 -v/home/user/articles.json:/data/db.json clue/json-server

    上面的示例在端口 80上公开JSON服务器 REST API,以便你现在可以浏览到:

    
    http://localhost/
    
    
    
    

    这是 Docker的惯例中非常常见的设置:

    • -d 将在后台运行分离的实例
    • -p {OutsidePort}:80 将web服务器绑定到给定的外部端口
    • -v {AbsolutePathToJsonFile}:/data/db.json 应该传递给将给定JSON文件放入容器中
    • clue/json-server 这里 Docker 映像的名称

    帮助

    你可以提供任意数量的JSON服务器参数,这些参数将通过未经修改的。

    $ docker run -it --rm clue/json-server --help

    JSON源

    /data/db.json ( 在上面的例子中) 中挂载文件时,它将自动用作普通JSON数据源文件。

    一个示例文件可以如下所示:

    {
     "posts": [
     { "id": 1, "body": "foo" },
     { "id": 2, "body": "bar" }
     ],
     "comments": [
     { "id": 1, "body": "baz", "postId": 1 },
     { "id": 2, "body": "qux", "postId": 2 }
     ]
    }

    种子文件

    如果将文件挂载到 /data/file.js,它将自动用作JS种子文件。

    JSON服务器需要JS文件导出一个返回对象的函数。 如果需要programmaticaly创建大量数据,种子文件非常有用。

    一个示例文件可以如下所示:

    module.exports=function() {
     var data = {};
     data.posts= [];
     data.posts.push({ id:1, body:'foo' });
     //...return data;
    }

    Server  API  BASE  图像  DOC  REST  
    相关文章