6 releases (3 stable)

new 1.0.2	Apr 20, 2024
1.0.1	Feb 13, 2024
1.0.0	Dec 3, 2023
0.1.2	Jun 9, 2021
0.1.0	Feb 27, 2021

#369 in Web programming

27 downloads per month

Apache-2.0

1MB
13K SLoC

LINE Messaging API SDK for Rust

Introduction

The LINE Messaging API SDK for Rust makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.

Documentation

See the official API documentation for more information.

English: https://developers.line.biz/en/docs/messaging-api/overview/
Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/

Requirements

This library requires stable/beta Rust.

Installation

$ cargo add line-bot-sdk-rust

Web framework support

Extract x-line-signature from the request header.

Use `rocket` framework

[dependencies.line-bot-sdk-rust]
version = "1.0.0"
features = ["rocket_support"]

use line_bot_sdk_rust::support::rocket::Signature;
use rocket::{http::Status, post};

#[post("/callback", data = "<body>")]
async fn world(signature: Signature, body: String) -> (Status, &'static str) {
    ...
}

Use `actix_web` framework

[dependencies.line-bot-sdk-rust]
version = "1.0.0"
features = ["actix_support"]

use actix_web::{post, web, Error, HttpResponse};
use line_bot_sdk_rust::support::actix::Signature;

#[post("/callback")]
async fn callback(signature: Signature, bytes: web::Bytes) -> Result<HttpResponse, Error> {
    ...
}

Configuration

use line_bot_sdk_rust::client::LINE;
use std::env;

fn main() {
    let access_token: &str =
        &env::var("LINE_CHANNEL_ACCESS_TOKEN").expect("Failed to get LINE_CHANNEL_ACCESS_TOKEN");

    let line = LINE::new(access_token.to_string());
}

How to use

The LINE Messaging API uses the JSON data format.

Example. Parse body (&str) into Result<CallbackRequest, serde_json::Error>.

let request: Result<CallbackRequest, serde_json::Error> = serde_json::from_str(body);

match request {
    Err(err) => {
        // error handling
    },
    Ok(req) => {
        for e in req.events {
            // Processing for various events
        }
    }
}

EchoBot examples

with Rocket framework

$ cd examples
$ cargo run --bin rocket

source: rocket example

with actix_web framework

$ cd examples
$ cargo run --bin actix_web

source: actix_web example

Contributing

Please make a contribution 😆

License

Copyright 2023 nanato12

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependencies

~15–51MB
~1M SLoC