node-webmention-testendpoint

A tool to test your webmention clients

Usage no npm install needed!

<script type="module">
  import nodeWebmentionTestendpoint from 'https://cdn.skypack.dev/node-webmention-testendpoint';
</script>

README

Webmention Test Endpoint

A tool to test your 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 of @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.

?type={link,a,head}
  • link will add a <link rel="webmention" href="..." /> to the HTML-head
  • a will add a link <a rel="webmention" href="...">Endpoint</a> to the HTML-body
  • head will add a HTTP-Link header Link: <http://...>; 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: <link rel="webmention" href="..." />
  • uri uses the http://webmention.org/ uri relation: <link rel="http://webmention.org/" href="..." />
  • both will add both relations: <link rel="webmention http://webmention.org/" href="..." />

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 and the Webmention Spec to find out more about the error codes.