https://github.com/pfefferle/node-webmention-testendpoint
A WebMention Test Endpoint
https://github.com/pfefferle/node-webmention-testendpoint
endpoint indieweb test webmention
Last synced: 4 months ago
JSON representation
A WebMention Test Endpoint
- Host: GitHub
- URL: https://github.com/pfefferle/node-webmention-testendpoint
- Owner: pfefferle
- License: mit
- Created: 2014-05-18T20:28:47.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T02:23:00.000Z (about 1 year ago)
- Last Synced: 2024-12-27T07:51:25.417Z (4 months ago)
- Topics: endpoint, indieweb, test, webmention
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/node-webmention-testendpoint
- Size: 55.7 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.md
Awesome Lists containing this project
- awesome-starred - pfefferle/node-webmention-testendpoint - A WebMention Test Endpoint (others)
README
# Webmention Test Endpoint
A tool to test your [Webmention](https://www.w3.org/TR/webmention/) client. Generates a demo-post and a demo-endpoint to test if your client parses the webmention-endpoint correctly and to check if the ping body is transmitted correctly.
Be sure to also test the [node-webmention-testpinger](https://github.com/voxpelli/node-webmention-testpinger) of [@voxpelli](https://github.com/voxpelli)
## Usage
First clone the repository
$ git clone https://github.com/pfefferle/node-webmention-testendpoint.git
Then run the app
$ node .
The tool will spin up a server on port 9247 and provides a test-post and a test-endpoint.
## Options
You can find the test-post under
http://localhost:9247/post
To test several possibilities, you have some options. Options can be added as query strings and will change the output of the test-posting.
### Type
With `type` you can choose the [autodiscovery format](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint).
?type={link,a,head}
* `link` will add a `` to the HTML-head
* `a` will add a link `Endpoint` to the HTML-body
* `head` will add a HTTP-Link header `Link: ; rel="webmention"`
You can combine several types with a semicolon separated list.
### Rel
Use 'rel' to define the link relation
?rel={id|uri|both}
* `id` uses the `webmention` relation: ``
* `uri` uses the `http://webmention.org/` uri relation: ``
* `both` will add both relations: ``
### URL
Use `url` to choose between absolute and relative urls
?url={abs|rel}
(the default is `abs`)
* `abs` absolute endpoint-urls
* `rel` relative endpoint-urls
### Status Code (HTTP)
Use `status_code` to simulate for example error-scenarios via HTTP-codes
?status_code=500
Check out [RFC 7231](http://tools.ietf.org/html/rfc7231) and the [Webmention Spec](https://www.w3.org/TR/webmention/#error-responses) to find out more about the error codes.