README.md

Service Name

Owner: Zhukov Max

Contacts: [email protected]

📖 Description

Simple project description with few examples, schemas and gifs if any.

🎯 Todo

• One
• Two
• Three
• Four

🔗 Links

• Confluence
• ReDoc
• Postman
• Production

☁️ Deployment

To run server:

1. Fill yaml in github actions dir
2. Run workflow
3. ...
4. Profit

💻 Usage

java -jar df.jar [OPTIONS] [FLAGS] [COMMANDS]                                 
                                                                              
OPTIONS:                                                                       
   --host <host>            host name, default: localhost                      
   --port <number>          HTTP TCP port number, default: 8080                

                                                                               
FLAGS:                                                                         
   --no-log                 disable request/response console logging           
   --no-log-request-info    disable request info in console logging            
   --no-log-headers         disable request/response headers in console logging
       
                                                                               
COMMANDS:                                                                      
   --help                   print help message                                 
   --print-info             print dump files statistics to stdout as json/yaml 
   --print-requests         print dump requests to stdout as json/yaml         
   --print-openapi          print OpenAPI specification to stdout as json/yaml

🔭 Usage Examples

Start server on dump file:

java -jar df.jar --dump dump.txt

Start server with built-in OpenAPI client:

java -jar df.jar --openapi-path /api --dump dump.txt

more examples…

Start server on few dump files:

java -jar df.jar --dump dump1.txt dump2.txt dump3.txt

Start server with built-in OpenAPI client with custom title:

java -jar df.jar --openapi-path /api --openapi-title 'My REST API v18.2.1' --dump dump.txt

🧐 Code analysis

We use some tools to ensure code quality:

• flake8 – code style
• isort – imports order
• mypy – types annotation
• bandit – security: our code

To perform all checks, run:

make check

🧪 Tests

make test

📦 Containerization

Docker

You can use docker and docker-compose to work with your project.

To build a docker image, use:

docker build --ssh default . -t my-service

And run with:

docker run my-service

Options for docker run are:

• -d: Run in detached mode, does not hang your terminal session.
• --rm: Removes container after finish
• -it: Runs interactively
• docker run -it --rm my-service <command>: run a command using the container image

Additional docker commands

• docker ps: Checks docker images running.
• docker exec -it <container_id> <command>: Runs a command inside the running container.