Add examples

.eslintignore

@@ -1,2 +1,3 @@
 lib/
-bin/
+bin/
+examples/

.gitignore

@@ -2,4 +2,3 @@
 *.log
 node_modules/
 lib/
-package-lock.json

.npmignore

@@ -1,3 +1,4 @@
 src/
 test/
-tsconfig.json
+tsconfig.json
+examples/

examples/.gitignore

@@ -0,0 +1,3 @@
+*.yaml
+*.json
+node_modules/

examples/README.md

@@ -0,0 +1,6 @@
+## How to run example
+
+1. In the root folder, run `$ npm run build & npm link outdoc`
+2. Go to the **examples** folder, do `$ npm install`
+3. Running the script `$ npm run express-mocha`
+4. Check the output ***examples/api.yaml*

examples/express_jest/case1.test.js

@@ -0,0 +1,72 @@
+const supertest = require('supertest');
+const app = require('./index.js')
+const request = supertest(app)
+
+describe('api testing', () => {
+  test('should able to find all', (done) => {
+    request
+      .get('/projects')
+      .set('x-api-key', 'wayne-test')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+
+  test('should able to find one', (done) => {
+    request
+      .get('/projects/uuid-1234')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+
+  test('should able to find one 401', (done) => {
+    request
+      .get('/projects/401')
+      .expect(401)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+
+  test('should able to find one 404', (done) => {
+    request
+      .get('/projects/404')
+      .expect(404)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+
+  describe('users', () => {
+    test('should able to find one user', (done) => {
+      request
+        .get('/users/user-wayne')
+        .expect(200)
+        .end(function(err, res) {
+          if (err) throw err;
+          done()
+        });
+    })
+
+    test('should able to post', (done) => {
+      request
+        .post('/users')
+        .set('content-type', 'application/json')
+        .send({
+          name: 'user wayne'
+        })
+        .expect(201)
+        .end(function(err, res) {
+          if (err) throw err;
+          done()
+        });
+    })
+  })
+})

examples/express_jest/case2.test.js

@@ -0,0 +1,32 @@
+const supertest = require('supertest');
+const app = require('./index.js')
+const request = supertest(app)
+
+describe('api testing', () => {
+  test('should able to path', (done) => {
+    request
+      .patch('/projects/uuid-1234')
+      .set('content-type', 'application/json')
+      .set('Accept', 'application/json')
+      .send({
+        project: {
+          tags: ['2016', '2017']
+        }
+      })
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+
+  test('should able to delete', (done) => {
+    request
+      .delete('/projects/uuid-2')
+      .expect(204)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+})

examples/express_jest/case3.test.js

@@ -0,0 +1,16 @@
+const supertest = require('supertest');
+const app = require('./index.js')
+const request = supertest(app)
+
+describe('api testing', () => {
+  test('should able to find all', (done) => {
+    request
+      .get('/projects')
+      .set('x-api-key', 'wayne-test')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done()
+      });
+  })
+})

examples/express_jest/index.js

@@ -0,0 +1,76 @@
+const express = require('express');
+const app = express();
+const port = 3000;
+
+if (process.env.NODE_ENV === "test") {
+  const { OutDoc } = require('../../lib/index');
+  OutDoc.init();
+}
+
+app.get('/projects', (req, res) => {
+  res.json([{
+    id: '1',
+    name: 'dapi v1'
+  }, {
+    id: '2',
+    name: 'cominsoon'
+  }]);
+});
+
+app.get('/projects/:id', (req, res) => {
+  const { id } = req.params;
+  if (id === "404") {
+    return res.sendStatus(404);
+  }
+  if (id === "401") {
+    return res.status(401).json({
+      error: {
+        code: '123',
+        message: '401 unauth'
+      }
+    });
+  }
+  return res.json({
+    id: '2',
+    name: 'cominsoon'
+  });
+});
+
+app.patch('/projects/:id', (req, res) => {
+  res.json([{
+    id: '23',
+    name: 'cominsoon'
+  }]);
+});
+
+app.post('/projects', (req, res) => {
+  res.status(201).json([{
+    id: '1',
+    name: 'dapi v1'
+  }]);
+});
+
+app.delete('/projects/:id', (req, res) => {
+  res.sendStatus(204);
+});
+
+app.get('/users/:id', (req, res) => {
+  const { id } = req.params;
+  return res.json({
+    id: '1',
+    name: 'wayne user'
+  });
+});
+
+app.post('/users', (req, res) => {
+  res.status(201).json([{
+    id: '1',
+    name: 'user v1'
+  }]);
+});
+
+if (process.env.NODE_ENV !== 'test') {
+  app.listen(port, () => console.log(`Listening on port ${port}`));
+}
+
+module.exports = app;

examples/express_mocha/cases1.test.js

@@ -0,0 +1,72 @@
+const request = require('supertest');
+
+const app = require('./index.js');
+
+describe('api testing', () => {
+  it('should able to find all', (done) => {
+    request(app)
+      .get('/projects')
+      .set('x-api-key', 'outdoc-test')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one', (done) => {
+    request(app)
+      .get('/projects/uuid-1234')
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one 401', (done) => {
+    request(app)
+      .get('/projects/401')
+      .expect(401)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to find one 404', (done) => {
+    request(app)
+      .get('/projects/404')
+      .expect(404)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  describe('users', () => {
+    it('should able to find one user', (done) => {
+      request(app)
+        .get('/users/user-wayne')
+        .expect(200)
+        .end(function(err, res) {
+          if (err) throw err;
+          done();
+        });
+    });
+
+    it('should able to post', (done) => {
+      request(app)
+        .post('/users')
+        .set('content-type', 'application/json')
+        .send({
+          name: 'user wayne'
+        })
+        .expect(201)
+        .end(function(err, res) {
+          if (err) throw err;
+          done();
+        });
+    });
+  });
+});

examples/express_mocha/cases2.test.js

@@ -0,0 +1,46 @@
+const request = require('supertest');
+
+const app = require('./index.js');
+
+describe('api testing', () => {
+  it('should able to path', (done) => {
+    request(app)
+      .patch('/projects/uuid-1234')
+      .set('Accept', 'application/json')
+      .send({
+        project: {
+          tags: ['2016', '2017']
+        }
+      })
+      .expect(200)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to post', (done) => {
+    request(app)
+      .post('/projects')
+      .set('content-type', 'application/json')
+      .set('x-api-key', 'wayne-test')
+      .send({
+        name: 'john'
+      })
+      .expect(201)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+
+  it('should able to delete', (done) => {
+    request(app)
+      .delete('/projects/uuid-2')
+      .expect(204)
+      .end(function(err, res) {
+        if (err) throw err;
+        done();
+      });
+  });
+});