dilagurung / watch-your-profamity

A simple API to check whether a string contains profanity. Used as an experiment to build a RESTful API using Spring Boot.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Watch Your Profamity

A simple profanity filter. Returns whether the submitted string contains profanity or not.

Usage

To run execute: mvn spring-boot:run from the project root. By default it will attempt to run on port 8082.

Example usage will check whether the string 'foo' contains profanity:

GET /profanity/check?text=foo 

Swagger Docs

While running the API, you can access the swagger documentation at:

/swagger-ui.html

About

A simple API to check whether a string contains profanity. Used as an experiment to build a RESTful API using Spring Boot.

License:MIT License


Languages

Language:Java 84.8%Language:Shell 8.6%Language:Batchfile 6.6%