{"id":23909752,"url":"https://github.com/swagchat/chat-api","last_synced_at":"2025-04-11T11:24:25.438Z","repository":{"id":57484924,"uuid":"87257888","full_name":"swagchat/chat-api","owner":"swagchat","description":"swagchat Chat API - REST API -","archived":false,"fork":false,"pushed_at":"2019-01-07T01:54:17.000Z","size":69054,"stargazers_count":6,"open_issues_count":18,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T07:51:09.289Z","etag":null,"topics":["api","chat","docker","golang","messaging","microservice","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swagchat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-05T02:39:42.000Z","updated_at":"2021-04-26T14:42:18.000Z","dependencies_parsed_at":"2022-09-26T18:51:46.773Z","dependency_job_id":null,"html_url":"https://github.com/swagchat/chat-api","commit_stats":null,"previous_names":["fairway-corp/swagchat-api"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagchat%2Fchat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagchat%2Fchat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagchat%2Fchat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagchat%2Fchat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swagchat","download_url":"https://codeload.github.com/swagchat/chat-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248382637,"owners_count":21094561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","chat","docker","golang","messaging","microservice","rest-api"],"created_at":"2025-01-05T06:31:55.134Z","updated_at":"2025-04-11T11:24:25.419Z","avatar_url":"https://github.com/swagchat.png","language":"Go","readme":"[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/github.com/swagchat/chat-api)](https://goreportcard.com/report/github.com/swagchat/chat-api)\n[![CircleCI](https://circleci.com/gh/swagchat/chat-api/tree/master.svg?style=svg)](https://circleci.com/gh/swagchat/chat-api/tree/master)\n[![Maintainability](https://api.codeclimate.com/v1/badges/5c3261e99582f147950c/maintainability)](https://codeclimate.com/github/swagchat/chat-api/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/5c3261e99582f147950c/test_coverage)](https://codeclimate.com/github/swagchat/chat-api/test_coverage)\n\n# swaghat Chat API\n\nswagchat is an open source chat components for your webapps.\n\nchat-api is designed to be easy to introduce to your microservices as well.\n\n**Currently developing for version 1**\n\n## Architecture\n\n![Architecture](https://client.fairway.ne.jp/swagchat/img/swagchat-start-guide-20170920.png \"Architecture\")\n\n\n##### Repository structure\n\n* [RTM API (Real Time Messaging API)](https://github.com/swagchat/rtm-api)\n* [SDK (TypeScript \u0026 JavaScript)](https://github.com/swagchat/swagchat-sdk-js)\n* [UIKit (A set of React components)](https://github.com/swagchat/react-swagchat)\n\n\n## API Reference\n\n[swagger (OpenAPI 2.0)](https://app.swaggerhub.com/apis/swagchat/swagchat-res_tful_api/0.3.2)\n\nSorry, maintenance is not keeping up.\n\n\n## Multiple datastore\n\nYou can choose from the followings.\n\n* sqlite3\n* MySQL\n* Google Cloud SQL\n\n## Multiple storage\n\nYou can choose from the followings.\n\n* Local Filesystem\n* Google Cloud Storage\n* Amazon S3\n\n## Multiple tracer\n\nYou can choose from the followings.\n\n* jaeger\n* zipkin\n* elastic APM\n\n## Quick start\n\n### Just run the executable binary\n\nYou can download binary from [Release page](https://github.com/swagchat/chat-api/releases)\n\n```\n# In the case of macOS\n./swagchat-api_darwin_amd64\n```\n\n### docker\n\n```\ndocker run swagchat/chat-api\n```\n[Docker repository](https://hub.docker.com/r/swagchat/chat-api/)\n\n## Configuration\n\nThe agent has various configuration options that can be specified via the command-line or via configuration files. All of the configuration options are completely optional. Defaults are specified with their descriptions.\n\nConfiguration precedence is evaluated in the following order:\n\n1. Command line arguments\n1. Environment Variables\n1. Configuration files\n\n### Specify the setting file (yaml format)\n\nTo override the default configuration options, make a copy of `defaultConfig.yaml` and then specify that file name in runtime parameter `config` and execute.\n\n```\n./chat-api -config myConfig.yaml\n```\n\n### Specify environment variables\n\nYou can overwrite it with environment variable.\n\n```\nexport HTTP_PORT=80 \u0026\u0026 ./chat-api\n```\n\n### Specify runtime parameters\n\nYou can overwrite it with runtime parameters.\n\n```\n./chat-api -httpPort 80\n```\n\nYou can check the variables that can be set with the help command of the executable binary.\n\n```\n./chat-api -h\n```\n\n## Development\n\n### go version\n\n1.8 or higher\n\n## License\n\nMIT License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagchat%2Fchat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswagchat%2Fchat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagchat%2Fchat-api/lists"}