https://github.com/jser/product-name
An API that provide product/library name for a URL.
https://github.com/jser/product-name
Last synced: 5 months ago
JSON representation
An API that provide product/library name for a URL.
- Host: GitHub
- URL: https://github.com/jser/product-name
- Owner: jser
- License: mit
- Created: 2022-03-06T05:21:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T03:54:42.000Z (about 1 year ago)
- Last Synced: 2025-05-06T04:33:16.166Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://jser-product-name.deno.dev/
- Size: 69.3 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSer.info Product Name API
Tiny Web API that provide product/library name for a URL.
This Web API using [JSer.info Dataset](https://github.com/jser/dataset).
## Response
- name: product name
- url: product url
- releaseNoteVersion: release note version if the target url is release note.
- `string | undefined`
- releaseNoteProbability: Do this url have release notes?
- 0 - 1
## Usage
Get Supported All products.
```
curl https://jser-product-name.deno.dev/
```
Get a product name for URL
```
curl https://jser-product-name.deno.dev/?url=${url}
```
## Example
```shell
$ curl https://jser-product-name.deno.dev/
[{"name":"jQuery Mobile","url":"http://jquerymobile.com"},{"name":"jQuery","url":"http://blog.jquery.com"},{"name":"Node","url":"http://blog.nodejs.org"},{"name":"Bootstrap","url":"http://blog.getbootstrap.com"}, ...]
```
```shell
$ curl "https://jser-product-name.deno.dev/?url=https://deno.com/blog/v1.19"
{"name":"Deno","url":"https://deno.com","releaseNoteProbability":0.7619047619047619,"releaseNoteVersion":"v1.19"}
```
No Data
```shell
$ curl "https://jser-product-name.deno.dev/?url=https://example.com"
null # status code is 400
```
## Develop
make run
## Test
make test
## Related
- [jser/dataset: JSer.infoのデータセットや処理ライブラリ](https://github.com/jser/dataset)
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
MIT