bsantosh909 / api-party Goto Github PK

Is your feature request related to a problem? Please describe.

Need to add a feature to mention if the API can be used without authentication or if it has any authentication system.

Describe the solution you'd like

The first solution is to add the key authentication key with the following values:

• none (e.g. JokeAPI)
• key (e.g. IMDB API)
• oauth (e.g. Discord)

I guess we might need to add another key to indicate if the API requires signup or not. (* This is completely optional)

Describe alternatives you've considered

N/A. Feedbacks are welcome though

Additional context

Anyone working on this issue will have to proof-read all the existing API files and add the key-value to those files.
And also update the frontend to display the data properly on the cards.

Refer to #275 which does similar thing

Description

Using only string values in placeholders is recommended as otherwise, the value may be wrongly displayed; for example, if an object value is directly included in a string, it will be shown as [object Object]. Using only string values can also ensure that null or undefined values are not directly …

Occurrences

There is 1 occurrence of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/TheLearneer/api-party/issue/JS-0378/occurrences/

Is your feature request related to a problem? Please describe.

The external links can be improved a bit.

Describe the solution you'd like

It would be great to add the follow to the external API links:

• ref query with value apiParty
• external property to the NuxtLink component (https://v3.nuxtjs.org/api/components/nuxt-link#props)

Describe alternatives you've considered

N/A

Additional context

In order to add the ref to the links we can use template string from the href prop and add ?ref=apiParty in the prop itself

Is your feature request related to a problem? Please describe.

Some of the APIs stop working over time either if they are stopped being worked or not maintained for X period of time or what-so-ever be the reason.
We need to filter out such APIs from the list.

Describe the solution you'd like

A simple solution would be to add a simple key in the feature list of the API. The key can either be deprecated or broken with boolean value true for any such APIs which are not working.

Describe alternatives you've considered

N/A (Feedbacks are welcome)

Additional context

Anyone working on this will have to proofread all the existing APIs to see if they are working. If not, add the key to that specific API already.
Also the frontend has to be prepared accordingly by adding a tag in the card to properly portray this information.

Is your feature request related to a problem? Please describe.

Write a detailed article about API authentication.

Describe the solution you'd like

Explain about:

• Why is authentication necessary
• API key, OAuth
• rate limiting, ip whitelisting
• Authentication vs Authorization

Describe alternatives you've considered

N/A

Additional context

Create a file at https://github.com/TheLearneer/api-party/tree/main/src/content/wiki
Name it 2.api-authentication and write the content inside it

Please check https://github.com/TheLearneer/api-party/blob/main/src/content/wiki/1.what-is-api.md to know about some structure that needs to be followed

A api that help you get meaning of any word

Currently the project is unaware about lots of awesome API out there. Plan is to add as much awesome API as possible.
I will be going through adding API myself, but extra hands are always appreciated 😄

NOTE:
If you are planning to add an API to the list, make sure it is an working API and please add all the necessary key values.

Need to dockerize the application

Currently the only possible way to run the application is through the normal means. However I would love to get it dockerized so that it can work regardless of system constrains.

Is your feature request related to a problem? Please describe.
Currently images for the API is just a placeholder image. Replace all the placeholder image with actual image.

Describe the solution you'd like
Upload the image for the API in assets or static directory so that it can be used.

Describe alternatives you've considered
Use web url of the API image. But the earlier solution is preferred because in that way there is better control at the system

What to do?

Write a detailed article about introduction to API (What is an API).
The API is to be written in laymen terms such that even a 5th grader should be able to understand it properly.

Where to update the file?

You can update the file content at https://github.com/TheLearneer/api-party/blob/main/src/content/wiki/1.what-is-api.md
It will then be rendered at https://apiparty.vercel.app/wiki/what-is-api

How long does it need to be?

I don't think there is a fixed keywords length requirement, any amount of keyword is acceptable as long as everything explained properly.

Is your feature request related to a problem? Please describe.

Write a detailed article about consuming API.

Describe the solution you'd like

Explain about:

• Ways to consume API (mobile apps, web apps, scripts, tools)
• Give example of APIs being consumed in mobile apps, web apps, script
• List out different tools that can be used to consume APIs (Postman, Hoppscotch etc)

Describe alternatives you've considered

N/A

Additional context

Create a file at https://github.com/TheLearneer/api-party/tree/main/src/content/wiki
Name it 3.usage-of-api and write the content inside it

Please check https://github.com/TheLearneer/api-party/blob/main/src/content/wiki/1.what-is-api.md to know about some structure that needs to be followed

Is your feature request related to a problem? Please describe.
After some recent contributions we have few categories that don't have any icons at all.
The categories are:

• Books
• Currency
• Foods

Describe the solution you'd like
Add a icons for all these categories that are missing

Describe alternatives you've considered
N/A

Additional context
Before opening a pull request for this task, I would love if you can propose the icons that would be best fit for the website. (i.e. share the image of the icons)

Category icons for 'development' and 'miscs' do not exist.

Describe the bug
The logo of newly added api is not being displayed despite following all the steps mentioned to add a new api. I am unsure but I presume it is due to addition of a new category, although the error in terminal suggests category-icon error only, I am unable to see the actual api icon as well.

To Reproduce
Steps to reproduce the behavior:

• add a new api under a new category

Expected behavior
Expected to see an icon for the newly added api

Screenshots

Additional context
I saw the problem in my local build, don't know if this affect some other build or if this is some minor stupidity I am not catching yet, Nevertheless, I have decided to open a pull request with all the changes leading to the issue

Is your feature request related to a problem? Please describe.

Need to add a feature to mention if the API is entirely free, is entirely paid or has a free as well as paid plan.

Describe the solution you'd like

The first solution is to add the key payment key with the following values:

• free (e.g. Discord)
• paid (e.g. Stripe)
• upgradable (e.g. IP-API)

I guess we might need to add another key for the case when the paid APIs have option of free testing. For e.g. Stripe

Describe alternatives you've considered

N/A. Feedbacks are welcome though

Additional context

Anyone working on this issue will have to proof-read all the existing API files and add the key-value to those files.
And also update the frontend to display the data properly on the cards.

Is your feature request related to a problem? Please describe.

Build a simple API to fetch all the APIs listed inside this project.

Describe the solution you'd like

My idea is to use free solution like deta.sh for both storing the data and hosting the API itself.

Plans are to creating an action in this repository that updates once every day (or pushing to a specific branch), which will then add/update all the API items to the deta base.

The backend API (separate project) will have a simple route (paginated), that will list all the key properties and respond with the list.

Describe alternatives you've considered

N/A

Additional context

Maybe move the repository to an organization and work on there with peace 🤔

Is your feature request related to a problem? Please describe.

Write a detailed article about HTTP status code

Describe the solution you'd like

Explain about:

• Understanding status code
• List out all the status codes and give a very short introduction about it. (maybe use table?)
• Why they are important
• Porper usage

Describe alternatives you've considered

N/A

Additional context

Create a file at https://github.com/TheLearneer/api-party/tree/main/src/content/wiki
Name it 4.http-status-codes and write the content inside it

Please check https://github.com/TheLearneer/api-party/blob/main/src/content/wiki/1.what-is-api.md to know about some structure that needs to be followed

Description

A malicious actor can gain full control over the user's DOM window object. As such, this can lead to phishing attacks such as fake login prompts or password alerts being shown to the user.

Occurrences

There is 1 occurrence of this issue in the repository.

See all occurrences on DeepSource → deepsource.io/gh/TheLearneer/api-party/issue/JS-0712/occurrences/