-
-
Notifications
You must be signed in to change notification settings - Fork 559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create tags/categories for APIs #54
Comments
Hi Ivan, I'm interesting in do this work, please send me the instructions. |
Cool 👍 |
APIforthat uses the following categories: Search Backend Social Tools Financial Enterprise Entertainment Security Database Maps Education Health Music Shopping Blogging Storage Photos Messaging Weather |
Well I had a similar problem for https://cenit.io/directory, I reviewed ProgramableWeb, Zapier and other sources. That is the tags that we have (each one with more that 5 items in the directory): Accounting Some case are redundant, and could be improve. I think that is important use multi-tag classification. |
Some source of tags that we can use like references: this first link I think that is a good reference:
others: |
@sanchojaf Very cool. Another is
I don't have any strong opinion about that, so let's ask more people.
We can also do some hybrid solutions, for e.g. categories + keywords, but it will require more work to maintain. |
Yes I agree with: NLP, CRM, CMS, and with ovoid 'Other'. +1, by tags |
I'd appreciate tags + keywords as described last by @IvanGoncharov |
Why not having keywords (include brands, services names, or anything...) + categories (fixed set of kind of APIs as listed above). I think both keywords and categories are subsets of tags. So why not having 2 arrays, one Also for having all tags lowercases (e.g. Love the idea of these tags/categories/keywords :) |
Is it worth stating explicitly what the expected use case is for tags/categories/keywords? My gut feeling would be to go with one category (what the API is, where it is, e.g. in a directory or menu structure) and an array of tags or keywords (how to find the API). We could define the categories, then the tags/keywords would be the set of categories (for alternatives to the main category) + any other tag/keyword value. +1 for correct capitalisation of acronyms. |
First of all, let's agree on terms we use because there's some mess:
So I agree with @MikeRalphson that we should start from use cases. For sure we should have either tags or keywords in addition to the category. I don't have the strong opinion about tags vs keywords. +1 for correct capitalisation of acronyms. |
I don't like very much the idea of a main category, is rigid a classification, and sometime have issues when properties of an item belong to more that one class. Duplications in groups is not necessary a problem. For other side I recognize that have a simple classification system is more easy for maintain. Examples:
|
Agree, actually, duplications is not a big problem in comparison to choosing only one main category for each API |
I will try to summarise discussion in more formal proposal: x-APIs.guru-tags:
- Video
- Social And for x-APIs.guru-tags:
- Social
- CMS So when user clicks on Tags names are optimised to be directly presented to the user, for example At the same time, we support optional @sanchojaf @MikeRalphson @bobby-brennan @RomanGotsiy @mittsh @oliver-xapix-io @darklynx |
One more things, I will add validation check for tag names, so they always are from the same set and with the same letter case. If somebody adds |
Will you add all tags and keywords as patches, or would you want APIs.guru-aware APIs to add them to the source? |
It makes sense to add But |
Let's wait a day to hear more feedback before starting to discuss the list of tags. |
This sounds good to me, will definitely help with organizing any-api.com. {
"info": {"title": "My API"},
"x-APIs.guru": {
"tags": ["foo", "bar"]
}
} One question: how should I go about utilizing both |
I like the idea to support tags and keywords. Tags allow to group APIs into a list of known categories, the list is fixed (or slowly growing) so that developers can not reintroduce the same category under slightly different name by mistake. Keywords are important to those developers who are not satisfied with standard set of tag values and would like to add additional markers. I also like the idea of tag weight bound to the natural order in the list of tags - simple, clean, and consistent. In this case keywords cannot be mixed with tags though and they should be used for different use cases: e.g to display main categories - tags only, to apply in search results or display a keywords cloud - tags + keywords I personally would prefer a set of lower cased single word tags :) (I'm a programmer and I know the advantages of such set, e.g. the localization of tags in this case could be a simple Map/Hashtable in many programming languages) but I'm fine if you decide for human readable set of tags with preferred natural capitalization. |
I agree with using lowercase and underscore tags. You can then serve {
"social": {
"title": "Social",
"description": "Interact with social networks and share media"
}
} |
1+ for lowercase and underscore too 1+ tags.json:
e.g. {
"internet_of_things": {
"title": "Internet of Things",
"slug": "internet-of-things"
},
"nlp": {
"title": "NLP",
"slug": "nlp",
"description": "Natural Language Processing"
}
} |
Summary after second round:
iot:
title: 'IoT'
description: 'Internet of Things'
nlp:
title: 'NLP'
description: 'Natural Language Processing' @sanchojaf If we support tags from small set, then we should provide Next step would be to create initial list of tags as |
@IvanGoncharov I agree with your summary, yes I can do a PR. |
Hi All, let me know any feedback with initial list of tags.json, I know that could be improved a lot #61 |
I read Wiki article about tag and couple of articles about tag vs keyword. TL;DR Tags: An On-Site Filing System And it looks like I confuse few things so change names of extensions: Since automatic extraction of I also marked APIs.guru API as an example: |
@IvanGoncharov Could you add a 'suggested categories' input to your Add API form, maybe with a link to the list of categories (I can put that on the wiki)? This will help me remember to add categories to new APIs. Please also let me know if you'd prefer an issue on a different repo for website-related issues? |
@MikeRalphson For a time being this form live here: https://github.com/APIs-guru/APIs-guru.github.io P.S. I think this issue can be closed since absolute majority of APIs are tagged. |
Closing as above. Many thanks everyone, especially @LucyBot-Andrew ! |
It's very easy to add some OpenAPI extension like
x-categories
.But in order to tag every API a lot of manual work required.
If someone volunteers to do this work I can provide instruction and write all necessary code.
The text was updated successfully, but these errors were encountered: