Skip to content

Octokit requests vs. plugin rest endpoint methods #11

@pflorek

Description

@pflorek

Document the decision for rest over requests

There are two ways of using the GitHub REST API, the octokit.rest.* endpoint methods and octokit.request. Both act the same way, the octokit.rest.* methods are just added for convenience, they use octokit.request internally.

https://github.com/octokit/octokit.js#rest-api

With https://github.com/octokit/plugin-rest-endpoint-methods.js/ one can send all the request parameters as a single object, no matter if it's a route, query or body parameter

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions