Giter Club home page Giter Club logo

caesar-cipher's Introduction

Caesar-cipher

Hi! Welcome to the Caesar Cipher API :). This API it's an implementation of this basic encryption algorithm.

How to use it

It's really simple. The API expects a json with the following structure

{
    "shift": int,
    "content": str
}

where shift it's the shift you want to apply to the alphabet and content the message you want to encrypt/decrypt

Important: We only support messages in spanish with letters. If you use a number or special mark such as ! @ # ... the API will return an error. Another thing to mention is that all the messages are capitalized.

Endpoints

This API has two endpoints - or 3 if you count the root one - which are: encrypt and decrypt. I think it's clear what each endpoint do. For both, you just need to pass a json with the structure we already saw

Example

Let's say we want to encrypt the message "ZAPATO" with a shift=10. In that case we just need to POST to encrypt the following json

{
    "shift":10,
    "content":"ZAPATO"
}

And we'll get this response from the API

{
    "message":"JKZKDY"
}

If now we want to decrypt that message we need to do the same thing, but with decrypt

{
    "shift":10,
    "content":"JKZKDY"
}

And the API will return

{
    "message": "ZAPATO"
}

That's all! Enjoy using our API :D

caesar-cipher's People

Contributors

j-povea21 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.