Apidoc: Order in generated json

Created on 28 Feb 2014  路  16Comments  路  Source: apidoc/apidoc

I saw that the order of endopoints documentation are alphabetically. Thats cool... sometimes.

Will be more cool add a parm in documentation like @apiOrder 1
This will be cool to custom orders, or as simple like the order that you writte your documentation is the order that will be generated the JSON.

enhancement

Most helpful comment

A stupid way: Start with numbers

like this: @apiGroup 1. group name

:)

All 16 comments

+1
It would be very nice to sort apigroups and api request inside a group

+1 :)

+1

Today i'm studing http://apiary.io/

On my end I just need to specify the order of groups, the order of methods can be the same as the source code.

An other +1 :+1:

+1

I solved this adding a template to my project whose only difference is that, in main.js, instead of

    // api overwrite with ordered list
    api = newList;

it says

    // api overwrite with ordered list
    api = _.sortBy(newList, function (entry) {
        return entry.group + entry.name;
    });

my @apiName annotations have the form 04_GetUser or 07_CreateRow so I can force the order of appearance.

Since the Api Name doesn't show up in the generated page, I'm comfortable with this behavior.

Yeah the forced order could be great feature, also queries could be sorted also by the method 'post', 'get', 'delete', 'put' etc. Also showing method in sidebar gives quick overview and easier to navigate.

+1 for a structured way to define order. @apiOrder seems good

Added an order list in apidoc.json
http://apidocjs.com/#configuration-settings

+1 . @apiOrder inside group

+1

This feature isn't implemented yet? So... +1

+1

A stupid way: Start with numbers

like this: @apiGroup 1. group name

:)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

a-tonchev picture a-tonchev  路  4Comments

Abdelrhman-Hosny picture Abdelrhman-Hosny  路  3Comments

tyranron picture tyranron  路  3Comments

whitelujx picture whitelujx  路  3Comments

imfuxiao picture imfuxiao  路  6Comments