Community

API documentation, or lack of?

NodeBB Development

Suggested Topics

  • X

    Is there any widget or plugin for document catalog tree

    NodeBB Development
    0 Votes
    1 Posts
    139 Views
    X

    Is there any widget or plugin for document catalog tree

    like this
    01f33da0-9d81-455c-a1d7-a004970549f6-image.png

  • xinshoukeX

    Is there api to new topic using nodejs code?

    NodeBB Development
    0 Votes
    2 Posts
    1260 Views
    C

    I'm not sure if I understand your question exactly, but you can write a plugin to listen to a new route (URL endpoint) or interprocess communication and load and call NodeBB libraries.
    You may consider using this plugin Git repo as a bootstrap to get you started quickly. Remember that the plugin.json, package.json, and library.js are the first files to work with. The plugin repo name / directory name will need to match the glob nodebb-plugin-* and it needs to be directly under the node_modules/ directory which is at the root of your NodeBB directory.

  • PitaJP

    DevDocs - API Documentation Browser

    NodeBB Development
    0 Votes
    3 Posts
    2607 Views
    PitaJP

    @frissdiegurke

    Here is a link: http://devdocs.io/

    I can't believe I forgot that.

    For example I'm not able to disable any of the enabled APIs.

    Are you sure? Did you try clicking the "Select Documentation" button at the bottom? I'm pretty sure you can disable those...

    Also by selecting one of the APIs the URL changes but by refreshing the page-content gets changed.

    I don't see any page content changing, what do you mean?

  • sergej-saveljevS

    Add PHP API

    NodeBB Development
    0 Votes
    32 Posts
    16051 Views
    sergej-saveljevS
    <?php class nodebb { function category_add ($params='name=Default category name', $token='e9de6fb6-1234-5678-8bbc-b5073fd1edef'){ shell_exec('/usr/bin/curl -H "Authorization: Bearer '.$token.'" --data "'.$params.'" http://localhost:4567/forum/api/v1/categories'); } } $nodebb = new nodebb; $nodebb->category_add(); return false;

    Now it's much easier 🙂

  • psychobunnyP

    NodeBB Documentation

    Moved NodeBB Development
    0 Votes
    3 Posts
    5000 Views
    psychobunnyP

    Yeah I gotcha, I know exactly what you mean. It's something we'll think about eventually (traditional documentation generated from comments within source) but moving to repo is a step in that direction I would imagine.

    And thanks 🙂

    yeah will update the link tomorrow 🙂

Copyright © 2023 NodeBB | Contributors