Skip to content
This repository was archived by the owner on Dec 31, 2025. It is now read-only.
This repository was archived by the owner on Dec 31, 2025. It is now read-only.

Should language-specific clients/services/libraries be included into the documentation? #234

@mr-rock

Description

@mr-rock

Hi everyone! 👋

Recently I've been spending some time translating the documentation of this API into an OpenAPI/Swagger document and, in addition, I've built a service written in Swift on top of it, as I'd like to built an Amiibo-related cross-platform app for all types of Apple devices and the web soon.

While I was browsing at this API documentation, I stumbled upon this section in the FAQ page that mentions apps and/or products that are leveraging their data from this API. So I wonder if it's in good interest of this project to mention somewhere (either in its README file and/or in its Github pages documentation) the existence of any language-specific clients/services/libraries that interfaces to this API as well, so that any developer could use these dependencies to build their apps/products/services/etc with.

I definitely think that this change would:

  • simplify the implementation/integration of this API into 3rd party applications, products, and/or services;
  • allow for further study, comprehension, and possible improvements of the API endpoints design both at client and server sides;
  • expand the developers community around the API, and broadens its context.

Of course, I'm also considering that there might be some drawbacks:

  • possible increase in the use of this API, thus higher hosting costs;
  • possible more frequent misuses and more effort in API use policing;
  • possible service and/or data degradation.

What do you guys think about this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions