rest-api

KO | EN

gitlite — search

#javascript #react #typescript #llm #go #linux #nodejs #macos #cli #kubernetes #vue #awesome-list #openai #open-source

(★ 25)

This module is the REST API for phpList, powered by phpList 4

rest-api 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# phpList 4 REST API

[![Build Status](https://github.com/phpList/rest-api/workflows/phpList%20REST%20API%20Build/badge.svg)](https://github.com/phpList/rest-api/actions)
[![Latest Stable Version](https://poser.pugx.org/phplist/rest-api/v/stable.svg)](https://packagist.org/packages/phpList/rest-api)
[![Total Downloads](https://poser.pugx.org/phplist/rest-api/downloads.svg)](https://packagist.org/packages/phpList/rest-api)
[![Latest Unstable Version](https://poser.pugx.org/phplist/rest-api/v/unstable.svg)](https://packagist.org/packages/phpList/rest-api)
[![License](https://poser.pugx.org/phplist/rest-api/license.svg)](https://packagist.org/packages/phpList/rest-api)

## About phpList

phpList is an open source newsletter manager.

## About this package

This module is the REST API for phpList 4, providing functions for superusers
to manage lists, subscribers and subscriptions via REST calls. It uses
functionality from the `phplist/core` module (the phpList 4 core).
It does not contain any SQL queries, uses functionality from the new core for
DB access.

This module is optional, i.e., it is possible to run phpList 4 without the
REST API.

This new REST API can also be used to provide REST access to an existing
phpList 3 installation. For this, the phpList 3 installation and the phpList 4
installation with the REST API need to share the same database. For security
reasons, the REST APIs from phpList 3 and phpList 4 should not be used for the
same database in parallel, though.

## Installation

Please install this package via Composer from within the
[phpList base distribution](https://github.com/phpList/base-distribution),
which also has more detailed installation instructions in the README.

## API Documentation

Visit `https://phplist.github.io/restapi-docs/` endpoint to access the full interactive documentation for `phpList/rest-api`.

Look at the **"API Documentation with Swagger"** section in the [contribution guide](.github/CONTRIBUTING.md) for more information on API documenation.

## Local demo with Postman

You can try out the API using pre-prepared requests and the Postman GUI 
tool. Install Postman as a browser extension or stand-alone app, open the 
[phpList 4 REST API Demo collection](https://documenter.getpostman.com/view/3293511/phplist-4-rest-api-demo/RVftkC9t#4710e871-973d-46fa-94b7-727fdc292cd5)
and click "Run in Postman".

## Contributing to this package

Please read the [contribution guide](.github/CONTRIBUTING.md) on how to
contribute and how to run the unit tests and style checks locally.

### Code of Conduct

This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to uphold
this code.

### Code style checks
```bash
vendor/bin/phpstan analyse -l 5 src/ tests/
vendor/bin/phpmd src/ text vendor/phplist/core/config/PHPMD/rules.xml
vendor/bin/phpcs --standard=vendor/phplist/core/config/PhpCodeSniffer/ src/ tests/
```

rest-api

rest-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

rest-api

rest-api 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README