Merge pull request #13 from nanato12/feature/doc

Create documentation

Author: nanato12

src/bot.rs

@@ -1,3 +1,5 @@
+//! HTTP Client
+
 use reqwest::blocking::{Client, Response};
 use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION, CONTENT_TYPE};
 use reqwest::Error;
@@ -14,6 +16,11 @@ pub struct HttpClient {
 }
 
 impl HttpClient {
+    /// # Note
+    /// Instantiate a HttpClient.
+    /// ```
+    /// let http_client = HttpClient::new("<channel secret>");
+    /// ```
     pub fn new(channel_token: &str) -> HttpClient {
         let mut headers = HeaderMap::new();
         headers.insert(
@@ -28,6 +35,11 @@ impl HttpClient {
         }
     }
 
+    /// # Note
+    /// `GET` request
+    /// ```
+    /// let res: Result<Response, Error> = http_client.get("https://example.com");
+    /// ```
     pub fn get(
         &self,
         endpoint: &str,
@@ -43,6 +55,11 @@ impl HttpClient {
             .send()
     }
 
+    /// # Note
+    /// `POST` request
+    /// ```
+    /// let res: Result<Response, Error> = http_client.post("https://example.com");
+    /// ```
     pub fn post(&self, endpoint: &str, data: Value) -> Result<Response, Error> {
         let uri = Url::parse(&format!("{}{}", self.endpoint_base, endpoint)).unwrap();
         self.client
@@ -52,6 +69,11 @@ impl HttpClient {
             .send()
     }
 
+    /// # Note
+    /// `PUT` request
+    /// ```
+    /// let res: Result<Response, Error> = http_client.put("https://example.com");
+    /// ```
     pub fn put(&self, endpoint: &str, data: Value) -> Result<Response, Error> {
         let uri = Url::parse(&format!("{}{}", self.endpoint_base, endpoint)).unwrap();
         self.client
@@ -61,6 +83,11 @@ impl HttpClient {
             .send()
     }
 
+    /// # Note
+    /// `DELETE` request
+    /// ```
+    /// let res: Result<Response, Error> = http_client.delete("https://example.com");
+    /// ```
     pub fn delete(&self, endpoint: &str, data: Value) -> Result<Response, Error> {
         let uri = Url::parse(&format!("{}{}", self.endpoint_base, endpoint)).unwrap();
         self.client

src/client.rs

@@ -1,3 +1,5 @@
+//! Request events
+
 pub mod account_link;
 pub mod beacon;
 pub mod follow;

src/events/mod.rs

@@ -1,3 +1,65 @@
+//! # 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 Rust nightly.
+//! # Installation
+//! ```
+//! [dependencies]
+//! line-bot-sdk-rust = "0.1"
+//! ```
+//! # Configuration
+//! ```
+//! extern crate line_bot_sdk_rust as line;
+//! use line::bot::LineBot;
+//!
+//! fn main() {
+//!     let bot = LineBot::new("<channel secret>", "<channel access token>");
+//! }
+//! ```
+//! # How to use
+//! The LINE Messaging API uses the JSON data format.
+//! parse_event_request() will help you to parse the HttpRequest content and return a Result<[Events](`events::Events`) , &'static str> Object.
+//! ```
+//! let result: Result<Events, &'static str> =
+//!     bot.parse_event_request(signature, body);
+//! ```
+//!
+//! ```
+//! match result {
+//!     Ok(events) => {
+//!         for event in events.events {
+//!             ...
+//!         }
+//!     }
+//!     Err(msg) => {}
+//! }
+//! ```
+//!
+//! # Contributing
+//! Please make a contribution 😆  
+//! <https://github.com/nanato12/line-bot-sdk-rust>
+//!
+//! # License
+//! ```
+//! Copyright 2021 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.
+//! ```
+
 pub mod bot;
 pub mod client;
 pub mod events;

src/lib.rs

@@ -1,3 +1,5 @@
+//! SendMessage Instances
+
 pub mod audio_message;
 pub mod flex_message;
 pub mod image_map_message;

src/messages/mod.rs

@@ -1,5 +1,11 @@
+//! Action objects
+//! # Note
+//! These are types of actions for your bot to take when a user taps a button or an image in a message.
+//! <https://developers.line.biz/en/reference/messaging-api/#action-objects>
 use serde_derive::Serialize;
 
+/// Action object
+/// # Note
 #[derive(Serialize, Debug)]
 pub struct Action {
     #[serde(flatten)]
@@ -8,6 +14,7 @@ pub struct Action {
     pub label: Option<String>,
 }
 
+/// Action object types
 #[derive(Serialize, Debug)]
 #[serde(tag = "type")]
 pub enum ActionType {
@@ -46,6 +53,9 @@ pub enum ActionType {
     Location {},
 }
 
+/// Alt uri object
+/// # Note
+/// URI opened on LINE for macOS and Windows when the action is performed.
 #[derive(Serialize, Debug)]
 pub struct AltUri {
     pub desktop: String,

src/objects/action.rs

@@ -1,3 +1,5 @@
+//! Various objects needed when sending message
+
 pub mod action;
 pub mod narrowcast;
 pub mod profile;

src/objects/mod.rs

@@ -1,8 +1,8 @@
 use serde_derive::Serialize;
 
+/// # Details
 /// Please read.
-/// https://developers.line.biz/ja/reference/messaging-api/#narrowcast-demographic-filter
-
+/// <https://developers.line.biz/ja/reference/messaging-api/#narrowcast-demographic-filter>
 #[derive(Serialize, Debug)]
 pub struct Filter {
     pub demographic: Demographic,

src/objects/narrowcast/filter.rs

@@ -1,8 +1,8 @@
 use serde_derive::Serialize;
 
+/// # Details
 /// Please read.
-/// https://developers.line.biz/ja/reference/messaging-api/#narrowcast-recipient
-
+/// <https://developers.line.biz/ja/reference/messaging-api/#narrowcast-recipient>
 #[derive(Serialize, Debug)]
 pub struct Recipient {
     #[serde(flatten)]

src/objects/narrowcast/recipient.rs

@@ -1 +1,3 @@
+//! Support for framework
+
 pub mod rocket_support;