Docpad api plugin | UnivUnix Github projects

Warning: Breaking changes in version 2.2.x

Due to changes on the file loading system, the configuration of the api created for this plugin needs some modifications. The new way is explained next.

Sorry for the inconvenience.

Also, if you have any problem, question or improvement, issues will be welcomed.

Installation

Install this DocPad plugin by entering docpad install api into your terminal.

Also you can install it using npm: npm install docpad-plugin-api[@latest, @alpha, @beta, @"version"]

Configuration

For plugin version 2.2.x

First, create your API. You have to use Javascript as language and you can use NodeJS or ExpressJS methods and objects.

Each Javascript file must have this structure:

// Each module.exports MUST BE a function with these two arguments
module.exports = function (opts, baseApiUrl){
  // The ExpressJS server is an attribute of opts.
  var server = opts.server

  // You can use ExpressJS functions (version 3.x)
  server.get(baseApiUrl + '/test', function (req, res, next) {
    return res.json({
      test: 'OK'
    })
  })

  server.get('/bbbb', function (req, res, next) {
    var err = new Error()
    next(err)
  })
}

Second, you need to create the api configuration file. It's in JSON format. This is the new step for newer versions, because you can set different apis using multiple configuration files.

You can name it as you want. In my case, I call it "dpaconfig.json"

{
  "baseApiUrl": "/testone",
  "src": [
    "testapi1/src/test11.js",
    "testapi1/src/test12.js"
  ]
}

Notes about dbaconfig.json file:

It's required to set the baseApiUrl and src variables.
The src routes have to be relative to Docpad website root folder (the same level as docpad configuration file).

Finally, set the route of each dpaconfig file in Docpad configuration file.

plugins:
  api:
    cfgSrc: [
      'testapi1/dpaconfig.json',
      'testapi2/dpaconfig.json',
      'testapi0/dpaconfig.json'
    ]

Notes about configuration: *You have to set relative routes using Docpad root folder as base.

And we're done. Enjoy your custom api without refactoring to ExpressJS.

For previous plugin versions (Deprecated)

First, you need to create a Javascript file inside your Docpad project. You must create that as a NodeJS module. Check the next example:

module.exports = function (opts, baseApiUrl) {
  var server = opts.server

  server.get(baseApiUrl + '/test', function (req, res, next) {
    return res.json({
      test: 'OK'
    })
  })

  server.get(baseApiUrl + '/bbbb', function (req, res, next) {
    var err = new Error()
    next(err)
  })
}

Finally, you have to put the path of the file in Docpad configuration file:

# DocPad Configuration File
# http://docpad.org/docs/config

# Define the DocPad Configuration
docpadConfig = {
  # Plugins configuration
  plugins:
    api:
      baseApiUrl: '/APIURLTEST'
      source: [
        file: 'api/api-test.js'
        ]
}

# Export the DocPad Configuration
module.exports = docpadConfig