apidoc on npm

0.17.7 (12 Nov 2018 09:11)

RESTful web API Documentation Generator


CHANGELOG.md

apiDoc Changelog

0.17.6

  • Common

    • Add Docker image.
  • CLI

    • Add kotlin to default file-filters.
    • Escape content of success examples.
  • Template

    • Update style.css to have horizontal scrolling for long URLs.
    • Add Vietnamese translation.
    • Add Turkish translation.
    • Blank optional parameters omitted from sample request.

0.17.5

  • CLI
    • Bugfix for folder problem.

0.17.4

  • Parser
    • Fix missing chars in root folder.
    • Replace removed fs-extra.walkSync with klaw-sync.

0.17.3

  • Template
    • Fix missing lodash dependency.

0.17.2

  • Template
    • Fix hidden optional field.

0.17.1

  • Template
    • Fix missing type in template.
    • Add check for empty header/footer nav points.

0.17.0

Add new @apiDeprecated annotation. Add new @apiPrivate annotation.

  • CLI

    • Add --private false|true parameter to export @apiPrivate marked methods.
    • Add .cls, .jsx, p, .pl, .vue file extensions.
    • Update dependencies.
  • Parser

    • Add @apiDeprecated support. 52
    • Added support for private APIs @apiPrivate. 530
    • Add support for plugins in scoped modules. 51
    • Remove deprecated lib wrench and replace with fs-extra.
    • Update dependencies.
  • Template

    • Update Bootstrap to 3.3.7.
    • Navigation filter added. 562
    • h2 links in Header / Footer files will now be visible in the main navigation. 525
    • Fix issue of left menu displaying major function in older version. 528
    • Replace lodash with only needed custom build lodash functions.
    • Update italian language file. 507

0.16.0

Greatest improvement: Plugin support

apidoc search now in global node modules dir and local node_modules for modules that start with apidoc-plugin-. (local installed plugins have higher priority)

View / clone: apidoc-plugin-test With a plugin you can add features like new parsers (this was possible before only with CLI param) or filters and workers.

Start adding hooks. Hooks can be used in plugins to extend or transform data.

If you need a hook in apidoc-core please add your hook and provide a pull request. How to add a hook into apidoc-core view source code

  • CLI

    • Update dependencies.
    • Remove not needed js-cookie module.
    • Allow for single source configuration. 458
  • Parser

    • Add Plugin Loader. Extend filter, parser, worker for plugin usage. example plugin
    • Add plugin hooks for found elements. available hooks
    • Add support for other encodings (default ist uf8). apidoc --encoding utf8
    • Add Lua support.
    • Add cpp support.
    • Add Arduino support.
  • Template

    • Do not use monospace for sans-serif fonts, only code fonts.
    • Sort field by grouping. 457
    • Add X-UA-Compatible for Internet Explorer to prevent loading only screen.
    • Reformat JSON example output.
    • Example table column widths set to 100%.
    • Add Italian translation.

0.15.1

  • Parser
    • Bugfix: Inherit error of lodash merge / mergeWidth split.

0.15.0

  • CLI

    • Update dependencies.
  • Parser

    • Upgrade markdown parser to version 0.6.
  • Template

    • Make ajaxRequest simpler. 384
    • Format response json. 396
    • Improve sendSampelRequest. 400
    • Add Catalan translation. 403
    • Bugfix: zh_cn translation string. 415
    • Bugfix: Template break on defined prototype methods.
    • Update json response css.
    • Update webfontloader.
    • Add monospace font fallback.

0.14.0

  • CLI

    • Clarify that -c option must be a directory.
  • Parser

    • Add support for : in @apiParam names.
    • Add Ruby doxygen-style support.
    • Add Groovy support.
    • Add Exlixir support.
    • Add Parameter name array syntax.
    • Add travis-ci tests for node 0.12.
  • Template

    • Add semver for correct sort order. 335
    • Add google webfontloader to fix scrollspy position after webfont loading.
    • Add semver for correct sort order.
    • Add Spanish translation.
    • Add Chinese Simplified (zh-cn) tranlsation.
    • Update to semantic tradition Chinese words.
    • Update Polish translation.
    • Ensure params isn't empty before sending.
    • Set required defaults for sample request.
    • Bugfix: Locale don't work with pt-br. 329
    • Bugfix: Empty Groups for Future Versions showing when old Versions are selected. 349
    • Bugfix: Add path to template variable (_col1).
    • Sample requests with GET parameters need to be added to the query string.
    • Fix handle bar expression to not apply html encode for data type field.
    • Typo in header.md.

0.13.2

  • Parser
    • Remove p-Tags from type-Field.
    • Update dependencies.
    • Update fixtures (type-Fields and line endings).

0.13.1

  • Template
    • Update French and Russian translation files.

0.13.0

  • Important changes:

    • Remove deprecated annotations (http://apidocjs.com/deprecated.html).
    • Replace markdown parser markdown-it.
  • CLI

    • Add path to config file (with -c).
    • Add multiple input locations (with -i).
    • Remove markdown config parameters, for custom configurations view MARKDOWN.md.
    • Disable warning if packageJson.apidoc was defined.
    • Add litcoffee and scala file extension.
  • Template

    • Add template.forceLanguage in apidoc.json to set a fixed language file without auto-detect the browser language.
    • Add word wrap for pure text examples.
    • Add Brazilian, French, Polish and Russian translation files.
  • Parser

    • Remove deprecated annotations (http://apidocjs.com/deprecated.html).
    • Replace markdown parser with markdown-it.
    • Add custom markdown parser support, view MARKDOWN.md for details.
    • Add support for markdown in the type section. Example: @apiParam {(CustomType)[http://...link-to-description.html]}

0.12.2

  • CLI

    • Bugfix: Multiple bin parameters. 244
  • Template

    • Update template vendor lib path-to-regexp.
    • Bugfix: Example overlaps navigation. 240
  • Parser

    • Update dependencies.

0.12.1

  • CLI

    • Add some version information for verbose / debug output.
  • Parser

    • Bugfix: Parse blocks with unknown parameters (before the block was skipped).
    • Bugfix: show correct block index.
    • Update dependencies.

0.12.0

  • Parser
    • Unindent strings in description fields. Mulitlines start with the same leading whitespaces. 173

0.11.0

  • CLI

    • Add parameter --parse-languages for custom language regex.
  • Parser

    • Add Clojure parser for .clj files.
    • Extend parser to transfer own language regex.
    • Update apidoc-core interface (replace arguments with setters).
  • Template

    • Add chinese and dutch translations files.

0.10.1

  • Bugfix: Path to apidoc-core.

0.10.0

  • Split apidoc code

    • apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it). You can use apidoc without change anything.

    • apidoc-core (for developers) is the parser and response the api-data.

    • apidoc-example (for developers) are the test files for the apidoc-spec.

  • CLI

    • Replace optimist (not maintained anymore) with nomnom: true / false parameters can now be used, e.g. enable markdown (default) --markdown or disable --no-markdown.
    • Add parameter --markdown.
    • Replace the custom Logger with winston.
  • Parser

    • Bugfix: Settings to enable / disable markdown (marked-gfm was previously used).
  • Template

    • Add generator.url and generator.name to the footer generator information (for custom ui-generators).
    • Move handlebars_helper.js to utils/
  • Common

    • Remove grunt dependencies (test run with npm run test).
    • Change grunt-apidoc (0.10.0) to use always the latest version of apiDoc.

0.9.1

  • Parser

    • Allow overwrite of packageInfo e.g. from grunt task (https://github.com/apidoc/apidoc/pull/177)
  • Bugfix: Extend parser regexp to allow inline comment-code (https://github.com/apidoc/apidoc/pull/180)

  • Bugfix: Slash only path in api triggered error (https://github.com/apidoc/apidoc/pull/159)

  • Bugfix: Scrollspy offset (https://github.com/apidoc/apidoc/pull/176)

  • Bugfix: Get package infos from package.json or apidoc.json (https://github.com/apidoc/apidoc/pull/169)

0.9.0

  • CLI

    • Allow to include an external file which can set the markdown settings. (https://github.com/apidoc/apidoc/pull/166)
  • Template

    • Add custom order in apidoc.json Append apiName or apiGroup in the order list:

      "order": [
        "MyGroupName",
        "MyParameterName",
        "MyOtherParameterName"
      ]
      
    • Speed up rendering of subtemplates (https://github.com/apidoc/apidoc/issues/164)

    • Bugfix: Special char doesn't show in @apiGroup. (https://github.com/apidoc/apidoc/issues/163)

0.8.2

  • Bugfix: apiGroupDescription from apiDefine not working. (https://github.com/apidoc/apidoc/issues/156)
  • Bugfix: remove deprecated message for apiPermission. (https://github.com/apidoc/apidoc/issues/154)
  • Bugfix: Testclient did not send JSON format. (https://github.com/apidoc/apidoc/issues/152)

0.8.1

  • Bugfix: Python regex doublequote. (https://github.com/apidoc/apidoc/issues/151)
  • Bugfix: Issue with multiple apiSuccessExample blocks. (https://github.com/apidoc/apidoc/issues/150)

0.8.0

  • Parameter

    • Add as replacement for all (now) deprecated define and structure methods:

      • @apiDefine
      • @apiUse
    • Deprecated:

      • @apiDefineErrorStructure
      • @apiDefineHeaderStructure
      • @apiDefinePermission
      • @apiDefineStructure
      • @apiDefineSuccessStructure
      • apiErrorTitle
      • apiErrorStructure
      • apiHeaderStructure
      • apiHeaderTitle
      • apiParamTitle
      • apiStructure
      • apiSuccessTitle
      • apiSuccessStructure
    • Remove unneeded methods since success and error response can be grouped:

      • @apiInfo
      • @apiInfoExample
      • @apiInfoTitle
    • Add for consistent usage:

      • @apiHeaderExample
      • @apiParamExample
    • Change:

      • @apiPermission, multiple permission usage in a block is allowed now. Permission names must be defined with @apiDefine.
    • Extend:

      • @apiParam with size and allowed values.
  • CLI

    • Show deprecated message. Show details with --debug or --verbose.
    • Improved error output.
    • Turn off verbose output by default.
    • Add debug output.
  • Parser

    • Ignore other doc-language @-parameters (enables jsdoc, phpdoc, ... again).
    • Add apidoc specification version to project file.
    • Correctly handle Erlang comments.
    • Bugfix: Markdown error on Empty description.
    • Revised worker preProcess / postProcess functions.
    • Change parser export names.
  • Template

    • Show size and allowed values in field description.
    • Change template sample request to handle custom named groups.
    • Update template vendor files (handlebars 2, requirejs)
    • Added support for using path-to-regexp in sample request.
    • Add jQueryAjaxSetup to apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings).
    • Hide the ul for tabs if no content.

0.7.2

  • Bugfix: Custom parsers not working. (https://github.com/apidoc/apidoc/issues/113)

0.7.1

  • Add type for @apiExample {type} Title, @apiSuccessExample, @apiErrorExample.
  • Add type switch in template.
  • Append filetype to fields at ajax reuqest testform.
  • Bugfix: Same file handling with regexp under win32. (https://github.com/apidoc/apidoc/issues/109)

0.7.0

  • Add rudimentary support for direct api calls (test requests) from within the doc.
  • Added ability to have forward slash (/) in parameter field names.
  • Add parameter --parse for parse only the files and return the parsed data.
  • Allow perl comments between "=pod" and "=cut".

0.6.5

  • Bugfix: Change RegExp for parameter values to handle all chars. (https://github.com/apidoc/apidoc/issues/97)

0.6.4

  • Bugfix: Reserved parameter names. (https://github.com/apidoc/apidoc/issues/96)

0.6.3

  • Bugfix: Multiple added url to api path after compared to other version. (https://github.com/apidoc/apidoc/issues/87)

0.6.2

  • Bugfix: Docs do not generate without optional @api [title]. (https://github.com/apidoc/apidoc/issues/82)
  • Bugfix: Escape example output in apiExample, apiErrorExample, apiSuccessExample. (https://github.com/apidoc/apidoc/issues/78)

0.6.1

  • Changing font include to work on HTTPS.
  • Some refactors and bugfixes.

0.6.0

  • Enable markdown for all description fields.
  • Add apidoc.json configuration file for primary configuration over package.json. (http://apidocjs.com/#configuration)
  • Add template specific configuration settings. (http://apidocjs.com/#configuration-template-settings)
  • Add support for Perl (Doxygen) comment-style.
  • Add simple CSS3 preloader.

0.5.2

  • Add css for printing.
  • Bugfix: Template IE8 compatibility. (https://github.com/apidoc/apidoc/issues/69)

0.5.1

  • Update node version to 0.10.x.
  • Add optional custom browser title with apidoc.title in package.json.
  • Add optional url endpoint with apidoc.url in package.json.
  • Bugfix: Template scrollbug. (https://github.com/apidoc/apidoc/issues/64)

0.5.0

0.4.4

  • Preserve other files when copying template files to the destination output dir.

0.4.3

  • Added a short-circuit check. (https://github.com/apidoc/apidoc/issues/41)

0.4.2

  • Bugfix: Fix parsing of multiline string. (https://github.com/apidoc/apidoc/issues/34)

0.4.1

  • Add support for CoffeeScript comment-style.

0.4.0

  • Add support for other comment-style. Now apiDoc supports:

    • Erlang
    • JavaScript (JavaDoc-Style: e.g. also useable in C#, Go, Dart, Java, PHP, TypeScript)
    • Python
    • Ruby
  • Add some programming language test cases.

  • Remove german code comments.

  • Upgrade all used node modules.

0.3.0

  • Replace deprecated node-markdown with marked.
  • Add cli parameter for marked --marked-..., watch all params with--help.
  • Upgrade all used node modules.

0.2.8

  • Bugfix: executable line delimiters. (again).

0.2.7

  • Bugfix: Allow usage of structures and titles in the same block. (https://github.com/apidoc/apidoc/issues/21)

0.2.6

  • Give some indication, in case file listing with fails. (https://github.com/apidoc/apidoc/pull/20)

0.2.5

  • Allow multiple structure includes.
  • Split and extend test-files.

0.2.4

  • Bugfix: Fix parsing for empty lines and removing stars on data that spans over multiple lines. (https://github.com/apidoc/apidoc/pull/11)
  • Remove http:// link to make https compliant. (https://github.com/apidoc/apidoc/pull/10)

0.2.3

  • Extend Template with url-param "compare=1" to show the compare version on page view.
  • Bugfix: Minor fix with double structure examples.

0.2.2

  • Bugfix: Template not show @apiSuccessExample @apiErrorExample.

0.2.1

  • Bugfix: executable line delimiters.

0.2.0

0.1.11

  • Allow whitespace in apiName and apiGroup.
  • Bugfix: Filter for directories.
  • Update Node Modules to newer versions.

0.1.10

  • Add -e exclude option for Files / Directories, example apidoc -e node_modules/.

0.1.10

  • Bugfix: Check for a valid title in Template. (https://github.com/apidoc/apidoc/pull/7)

0.1.9

  • Bugfix: Whitespace before comment block. (https://github.com/apidoc/apidoc/pull/2)

0.1.8

  • Change templates, enable navigation scroll.

0.1.7

0.1.6

  • Bugfix: OSX executable.

0.1.5

  • Official release.

Version History

Version Date
0.17.7 12 Nov 2018 09:11
0.17.6 19 May 2017 09:05
0.17.5 26 Jan 2017 10:01
0.17.4 23 Jan 2017 08:01
0.17.3 16 Jan 2017 17:01
0.17.2 16 Jan 2017 09:01
0.17.1 16 Jan 2017 09:01
0.17.0 13 Jan 2017 18:01
0.16.1 22 Apr 2016 09:04
0.16.0 21 Apr 2016 15:04
0.15.1 17 Feb 2016 09:02
0.15.0 12 Feb 2016 17:02
0.14.0 15 Dec 2015 15:12
0.13.2 14 Dec 2015 09:12
0.13.1 08 May 2015 15:05
0.13.0 08 May 2015 14:05
0.12.3 16 Apr 2015 19:04
0.12.2 16 Apr 2015 08:04
0.12.1 14 Jan 2015 12:01
0.12.0 22 Dec 2014 15:12
0.11.0 19 Dec 2014 14:12
0.10.1 18 Dec 2014 15:12
0.10.0 18 Dec 2014 15:12
0.9.1 15 Dec 2014 12:12
0.9.0 28 Nov 2014 14:11
0.8.2 24 Nov 2014 15:11
0.8.1 18 Nov 2014 09:11
0.8.0 17 Nov 2014 17:11
0.7.2 12 Sep 2014 14:09
0.7.1 05 Sep 2014 14:09
0.7.0 22 Aug 2014 14:08
0.6.5 12 Aug 2014 13:08
0.6.4 12 Aug 2014 08:08
0.6.3 08 Aug 2014 17:08
0.6.2 08 Aug 2014 13:08
0.6.1 08 Aug 2014 12:08
0.6.0 10 Jul 2014 15:07
0.5.2 03 Jul 2014 16:07
0.5.1 01 Jul 2014 13:07
0.5.0 27 Jun 2014 14:06
0.4.4 06 Jun 2014 15:06
0.4.3 09 May 2014 08:05
0.4.2 12 Mar 2014 08:03
0.4.1 06 Mar 2014 10:03
0.4.0 04 Mar 2014 16:03
0.3.0 23 Dec 2013 14:12
0.2.8 02 Dec 2013 14:12
0.2.7 30 Nov 2013 10:11
0.2.6 24 Sep 2013 09:09
0.2.5 21 Sep 2013 15:09
0.2.4 21 Aug 2013 10:08
0.2.3 08 Aug 2013 15:08
0.2.2 04 Jun 2013 10:06
0.2.1 31 May 2013 08:05
0.2.0 30 May 2013 21:05
0.1.11 28 May 2013 21:05
0.1.10 16 May 2013 09:05
0.1.9 26 Apr 2013 16:04
0.1.8 23 Apr 2013 15:04
0.1.7 23 Apr 2013 11:04
0.1.6 22 Apr 2013 16:04
0.1.5 20 Apr 2013 18:04