Documentation/Services

Service Template

The service-template-node project was a template for creating MediaWiki services in Node.js. It used technologies such as service-runner, Bluebird promises, express.js, mocha, istanbul, and Docker to make it simple to create robust services that conform to best practices.

The template has not been maintained and is no longer recommended for use. It is now recommended you use native Promises instead of Bluebird as the library is no longer maintained. Several services have removed dependency on service-runner and you should not expect it to be maintained in the near future.

Migration guide:

Consider using service-utils for easier migration.

• Use Node >= 20
• Replace preq (deprecated) with fetch (native)
• Replace bluebird (no longer maintained) with Promise (native)
• Replace istanbul (deprecated) with nyc (maintained)

Optional

• Replace mocha (still maintained) with test runner (native)

See also:

• https://gerrit.wikimedia.org/r/q/servicelib-node, which aimed to be a library rather than a template, performing a similar function and using many of the same functions (also not maintained.)
• https://gitlab.wikimedia.org/repos/data-engineering/service-utils, which aims to replace some of the functionality of service-runner

Topics

• API design practices
• Overview
• Configuration
• Useful Commands
• Coding guide
• Deployment
• Keeping your service up-to-date

Deployment

See the service deployment and operation guide.

Wikimedia Production Services

• Analytics Query Service
• Citoid
• Content translation
• Graphoid
• Maps
• Mathoid
• Mobile Content Service
• RESTBase

See also

• MW API index page for enwiki