Current section
Files
Jump to
Current section
Files
docs/dist/search_items-3ba01e0aaf.js
searchNodes=[{"doc":"JayaCurrencyConverter keeps the contexts that define your domain and business logic. Contexts are also responsible for managing your data, regardless if it comes from the database, an external API or others.","ref":"JayaCurrencyConverter.html","title":"JayaCurrencyConverter","type":"module"},{"doc":"The Accounts context.","ref":"JayaCurrencyConverter.Accounts.html","title":"JayaCurrencyConverter.Accounts","type":"module"},{"doc":"Creates a user. Examples iex> create_user ( %{ field : value } ) { :ok , % User { } } iex> create_user ( %{ field : bad_value } ) { :error , % Ecto.Changeset { } }","ref":"JayaCurrencyConverter.Accounts.html#create_user/1","title":"JayaCurrencyConverter.Accounts.create_user/1","type":"function"},{"doc":"Gets a single user. Raises Ecto.NoResultsError if the User does not exist. Examples iex> get_user! ( 123 ) % User { } iex> get_user! ( 456 ) ** (Ecto.NoResultsError)","ref":"JayaCurrencyConverter.Accounts.html#get_user!/1","title":"JayaCurrencyConverter.Accounts.get_user!/1","type":"function"},{"doc":"Returns the list of users. Examples iex> list_users ( ) [ % User { } , ... ]","ref":"JayaCurrencyConverter.Accounts.html#list_users/0","title":"JayaCurrencyConverter.Accounts.list_users/0","type":"function"},{"doc":"This is the Exchange core module that fetch rates and calculate the amount","ref":"JayaCurrencyConverter.Exchange.html","title":"JayaCurrencyConverter.Exchange","type":"module"},{"doc":"The function fetch_rates_from_currency/1 receives a string with the currency. Returns a ` float ` value . iex> Exchange . fetch_rates_from_currency ( "BRL" ) 6.418483","ref":"JayaCurrencyConverter.Exchange.html#fetch_rates_from_currency/1","title":"JayaCurrencyConverter.Exchange.fetch_rates_from_currency/1","type":"function"},{"doc":"This is the ExchangeRatesClient module that makes the request for the Exchanges Rates API.","ref":"JayaCurrencyConverter.ExchangeRatesClient.html","title":"JayaCurrencyConverter.ExchangeRatesClient","type":"module"},{"doc":"Perform a DELETE request. See request/1 or request/2 for options definition. delete ( "/users" ) delete ( "/users" , query : [ scope : "admin" ] ) delete ( client , "/users" ) delete ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#delete/3","title":"JayaCurrencyConverter.ExchangeRatesClient.delete/3","type":"function"},{"doc":"Perform a DELETE request. See request!/1 or request!/2 for options definition. delete! ( "/users" ) delete! ( "/users" , query : [ scope : "admin" ] ) delete! ( client , "/users" ) delete! ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#delete!/3","title":"JayaCurrencyConverter.ExchangeRatesClient.delete!/3","type":"function"},{"doc":"Perform a GET request. See request/1 or request/2 for options definition. get ( "/users" ) get ( "/users" , query : [ scope : "admin" ] ) get ( client , "/users" ) get ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#get/3","title":"JayaCurrencyConverter.ExchangeRatesClient.get/3","type":"function"},{"doc":"Perform a GET request. See request!/1 or request!/2 for options definition. get! ( "/users" ) get! ( "/users" , query : [ scope : "admin" ] ) get! ( client , "/users" ) get! ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#get!/3","title":"JayaCurrencyConverter.ExchangeRatesClient.get!/3","type":"function"},{"doc":"The function get_all_rates receives a string with the currency. Returns map in success or error if some thing was wrong. Examples iex> ExchangeRatesClient . get_all_rates "EUR" %{ "BRL" => 6.418483 , "EUR" => 1 , "JPY" => 129.340028 , "USD" => 1.131029 } iex> ExchangeRatesClient . get_all_rates "FOM" { :error , "invalid_base_currency" }","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#get_all_rates/1","title":"JayaCurrencyConverter.ExchangeRatesClient.get_all_rates/1","type":"function"},{"doc":"Perform a HEAD request. See request/1 or request/2 for options definition. head ( "/users" ) head ( "/users" , query : [ scope : "admin" ] ) head ( client , "/users" ) head ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#head/3","title":"JayaCurrencyConverter.ExchangeRatesClient.head/3","type":"function"},{"doc":"Perform a HEAD request. See request!/1 or request!/2 for options definition. head! ( "/users" ) head! ( "/users" , query : [ scope : "admin" ] ) head! ( client , "/users" ) head! ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#head!/3","title":"JayaCurrencyConverter.ExchangeRatesClient.head!/3","type":"function"},{"doc":"Perform a OPTIONS request. See request/1 or request/2 for options definition. options ( "/users" ) options ( "/users" , query : [ scope : "admin" ] ) options ( client , "/users" ) options ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#options/3","title":"JayaCurrencyConverter.ExchangeRatesClient.options/3","type":"function"},{"doc":"Perform a OPTIONS request. See request!/1 or request!/2 for options definition. options! ( "/users" ) options! ( "/users" , query : [ scope : "admin" ] ) options! ( client , "/users" ) options! ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#options!/3","title":"JayaCurrencyConverter.ExchangeRatesClient.options!/3","type":"function"},{"doc":"Perform a PATCH request. See request/1 or request/2 for options definition. patch ( "/users" , %{ name : "Jon" } ) patch ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) patch ( client , "/users" , %{ name : "Jon" } ) patch ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#patch/4","title":"JayaCurrencyConverter.ExchangeRatesClient.patch/4","type":"function"},{"doc":"Perform a PATCH request. See request!/1 or request!/2 for options definition. patch! ( "/users" , %{ name : "Jon" } ) patch! ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) patch! ( client , "/users" , %{ name : "Jon" } ) patch! ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#patch!/4","title":"JayaCurrencyConverter.ExchangeRatesClient.patch!/4","type":"function"},{"doc":"Perform a POST request. See request/1 or request/2 for options definition. post ( "/users" , %{ name : "Jon" } ) post ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) post ( client , "/users" , %{ name : "Jon" } ) post ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#post/4","title":"JayaCurrencyConverter.ExchangeRatesClient.post/4","type":"function"},{"doc":"Perform a POST request. See request!/1 or request!/2 for options definition. post! ( "/users" , %{ name : "Jon" } ) post! ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) post! ( client , "/users" , %{ name : "Jon" } ) post! ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#post!/4","title":"JayaCurrencyConverter.ExchangeRatesClient.post!/4","type":"function"},{"doc":"Perform a PUT request. See request/1 or request/2 for options definition. put ( "/users" , %{ name : "Jon" } ) put ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) put ( client , "/users" , %{ name : "Jon" } ) put ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#put/4","title":"JayaCurrencyConverter.ExchangeRatesClient.put/4","type":"function"},{"doc":"Perform a PUT request. See request!/1 or request!/2 for options definition. put! ( "/users" , %{ name : "Jon" } ) put! ( "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] ) put! ( client , "/users" , %{ name : "Jon" } ) put! ( client , "/users" , %{ name : "Jon" } , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#put!/4","title":"JayaCurrencyConverter.ExchangeRatesClient.put!/4","type":"function"},{"doc":"Perform a request. Options :method - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch] :url - either full url e.g. " http://example.com/some/path" or just "/some/path" if using Tesla.Middleware.BaseUrl :query - a keyword list of query params, e.g. [page: 1, per_page: 100] :headers - a keyworld list of headers, e.g. [{"content-type", "text/plain"}] :body - depends on used middleware: by default it can be a binary if using e.g. JSON encoding middleware it can be a nested map if adapter supports it it can be a Stream with any of the above :opts - custom, per-request middleware or adapter options Examples ExampleApi . request ( method : :get , url : "/users/path" ) # use shortcut methods ExampleApi . get ( "/users/1" ) ExampleApi . post ( client , "/users" , %{ name : "Jon" } )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#request/2","title":"JayaCurrencyConverter.ExchangeRatesClient.request/2","type":"function"},{"doc":"Perform request and raise in case of error. This is similar to request/2 behaviour from Tesla 0.x See request/2 for list of available options.","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#request!/2","title":"JayaCurrencyConverter.ExchangeRatesClient.request!/2","type":"function"},{"doc":"Perform a TRACE request. See request/1 or request/2 for options definition. trace ( "/users" ) trace ( "/users" , query : [ scope : "admin" ] ) trace ( client , "/users" ) trace ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#trace/3","title":"JayaCurrencyConverter.ExchangeRatesClient.trace/3","type":"function"},{"doc":"Perform a TRACE request. See request!/1 or request!/2 for options definition. trace! ( "/users" ) trace! ( "/users" , query : [ scope : "admin" ] ) trace! ( client , "/users" ) trace! ( client , "/users" , query : [ scope : "admin" ] )","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#trace!/3","title":"JayaCurrencyConverter.ExchangeRatesClient.trace!/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverter.ExchangeRatesClient.html#t:option/0","title":"JayaCurrencyConverter.ExchangeRatesClient.option/0","type":"type"},{"doc":"The Exchanges context.","ref":"JayaCurrencyConverter.Exchanges.html","title":"JayaCurrencyConverter.Exchanges","type":"module"},{"doc":"Creates a transaction. Examples iex> create_transaction ( %{ field : value } ) { :ok , % Transaction { } } iex> create_transaction ( %{ field : bad_value } ) { :error , % Ecto.Changeset { } }","ref":"JayaCurrencyConverter.Exchanges.html#create_transaction/2","title":"JayaCurrencyConverter.Exchanges.create_transaction/2","type":"function"},{"doc":"Gets a single transaction. Raises Ecto.NoResultsError if the Transaction does not exist. Examples iex> get_transaction! ( 123 ) % Transaction { } iex> get_transaction! ( 456 ) ** (Ecto.NoResultsError)","ref":"JayaCurrencyConverter.Exchanges.html#get_transaction!/1","title":"JayaCurrencyConverter.Exchanges.get_transaction!/1","type":"function"},{"doc":"Returns the list of transactions. Examples iex> list_transactions ( ) [ % Transaction { } , ... ]","ref":"JayaCurrencyConverter.Exchanges.html#list_transactions/1","title":"JayaCurrencyConverter.Exchanges.list_transactions/1","type":"function"},{"doc":"Conveniences for translating and building error messages.","ref":"JayaCurrencyConverterWeb.ErrorHelpers.html","title":"JayaCurrencyConverterWeb.ErrorHelpers","type":"module"},{"doc":"Translates an error message using gettext.","ref":"JayaCurrencyConverterWeb.ErrorHelpers.html#translate_error/1","title":"JayaCurrencyConverterWeb.ErrorHelpers.translate_error/1","type":"function"},{"doc":"A module providing Internationalization with a gettext-based API. By using Gettext , your module gains a set of macros for translations, for example: import JayaCurrencyConverterWeb.Gettext # Simple translation gettext ( "Here is the string to translate" ) # Plural translation ngettext ( "Here is the string to translate" , "Here are the strings to translate" , 3 ) # Domain-based translation dgettext ( "errors" , "Here is the error message to translate" ) See the Gettext Docs for detailed usage.","ref":"JayaCurrencyConverterWeb.Gettext.html","title":"JayaCurrencyConverterWeb.Gettext","type":"module"},{"doc":"Callback implementation for Gettext.Backend.dgettext/3 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dgettext/3","title":"JayaCurrencyConverterWeb.Gettext.dgettext/3","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.dgettext_noop/2 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dgettext_noop/2","title":"JayaCurrencyConverterWeb.Gettext.dgettext_noop/2","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.dngettext/5 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dngettext/5","title":"JayaCurrencyConverterWeb.Gettext.dngettext/5","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.dngettext_noop/3 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dngettext_noop/3","title":"JayaCurrencyConverterWeb.Gettext.dngettext_noop/3","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.dpgettext/4 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dpgettext/4","title":"JayaCurrencyConverterWeb.Gettext.dpgettext/4","type":"macro"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#dpgettext_noop/3","title":"JayaCurrencyConverterWeb.Gettext.dpgettext_noop/3","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.dpngettext/6 .","ref":"JayaCurrencyConverterWeb.Gettext.html#dpngettext/6","title":"JayaCurrencyConverterWeb.Gettext.dpngettext/6","type":"macro"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#dpngettext_noop/4","title":"JayaCurrencyConverterWeb.Gettext.dpngettext_noop/4","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.gettext/2 .","ref":"JayaCurrencyConverterWeb.Gettext.html#gettext/2","title":"JayaCurrencyConverterWeb.Gettext.gettext/2","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.gettext_comment/1 .","ref":"JayaCurrencyConverterWeb.Gettext.html#gettext_comment/1","title":"JayaCurrencyConverterWeb.Gettext.gettext_comment/1","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.gettext_noop/1 .","ref":"JayaCurrencyConverterWeb.Gettext.html#gettext_noop/1","title":"JayaCurrencyConverterWeb.Gettext.gettext_noop/1","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.handle_missing_bindings/2 .","ref":"JayaCurrencyConverterWeb.Gettext.html#handle_missing_bindings/2","title":"JayaCurrencyConverterWeb.Gettext.handle_missing_bindings/2","type":"function"},{"doc":"Callback implementation for Gettext.Backend.handle_missing_plural_translation/6 .","ref":"JayaCurrencyConverterWeb.Gettext.html#handle_missing_plural_translation/6","title":"JayaCurrencyConverterWeb.Gettext.handle_missing_plural_translation/6","type":"function"},{"doc":"Callback implementation for Gettext.Backend.handle_missing_translation/4 .","ref":"JayaCurrencyConverterWeb.Gettext.html#handle_missing_translation/4","title":"JayaCurrencyConverterWeb.Gettext.handle_missing_translation/4","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#lgettext/5","title":"JayaCurrencyConverterWeb.Gettext.lgettext/5","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#lngettext/7","title":"JayaCurrencyConverterWeb.Gettext.lngettext/7","type":"function"},{"doc":"Callback implementation for Gettext.Backend.ngettext/4 .","ref":"JayaCurrencyConverterWeb.Gettext.html#ngettext/4","title":"JayaCurrencyConverterWeb.Gettext.ngettext/4","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.ngettext_noop/2 .","ref":"JayaCurrencyConverterWeb.Gettext.html#ngettext_noop/2","title":"JayaCurrencyConverterWeb.Gettext.ngettext_noop/2","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.pgettext/3 .","ref":"JayaCurrencyConverterWeb.Gettext.html#pgettext/3","title":"JayaCurrencyConverterWeb.Gettext.pgettext/3","type":"macro"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#pgettext_noop/2","title":"JayaCurrencyConverterWeb.Gettext.pgettext_noop/2","type":"macro"},{"doc":"Callback implementation for Gettext.Backend.pngettext/5 .","ref":"JayaCurrencyConverterWeb.Gettext.html#pngettext/5","title":"JayaCurrencyConverterWeb.Gettext.pngettext/5","type":"macro"},{"doc":"","ref":"JayaCurrencyConverterWeb.Gettext.html#pngettext_noop/3","title":"JayaCurrencyConverterWeb.Gettext.pngettext_noop/3","type":"macro"},{"doc":"Module with named helpers generated from JayaCurrencyConverterWeb.Router.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html","title":"JayaCurrencyConverterWeb.Router.Helpers","type":"module"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#home_path/2","title":"JayaCurrencyConverterWeb.Router.Helpers.home_path/2","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#home_path/3","title":"JayaCurrencyConverterWeb.Router.Helpers.home_path/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#home_url/2","title":"JayaCurrencyConverterWeb.Router.Helpers.home_url/2","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#home_url/3","title":"JayaCurrencyConverterWeb.Router.Helpers.home_url/3","type":"function"},{"doc":"Generates the path information including any necessary prefix.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#path/2","title":"JayaCurrencyConverterWeb.Router.Helpers.path/2","type":"function"},{"doc":"Generates an integrity hash to a static asset given its file path.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#static_integrity/2","title":"JayaCurrencyConverterWeb.Router.Helpers.static_integrity/2","type":"function"},{"doc":"Generates path to a static asset given its file path.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#static_path/2","title":"JayaCurrencyConverterWeb.Router.Helpers.static_path/2","type":"function"},{"doc":"Generates url to a static asset given its file path.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#static_url/2","title":"JayaCurrencyConverterWeb.Router.Helpers.static_url/2","type":"function"},{"doc":"Generates the connection/endpoint base URL without any path information.","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#url/1","title":"JayaCurrencyConverterWeb.Router.Helpers.url/1","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_path/2","title":"JayaCurrencyConverterWeb.Router.Helpers.user_path/2","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_path/3","title":"JayaCurrencyConverterWeb.Router.Helpers.user_path/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_path/4","title":"JayaCurrencyConverterWeb.Router.Helpers.user_path/4","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_path/3","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_path/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_path/4","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_path/4","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_path/5","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_path/5","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_url/3","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_url/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_url/4","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_url/4","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_transaction_url/5","title":"JayaCurrencyConverterWeb.Router.Helpers.user_transaction_url/5","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_url/2","title":"JayaCurrencyConverterWeb.Router.Helpers.user_url/2","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_url/3","title":"JayaCurrencyConverterWeb.Router.Helpers.user_url/3","type":"function"},{"doc":"","ref":"JayaCurrencyConverterWeb.Router.Helpers.html#user_url/4","title":"JayaCurrencyConverterWeb.Router.Helpers.user_url/4","type":"function"},{"doc":"A aplicação conversor de moedas é uma API REST, chamada Jaya Currency Converter, com objetivo de converter valores de uma moeda de origem para uma moeda de destino. Você pode fazer a conversão nas seguintes moedas: Real brasileiro Dólar americano Euro Iene japonês As moedas serão referidas com o padrão internacional para facilitar a explicação.","ref":"readme.html","title":"JayaCurrencyConverter","type":"extras"},{"doc":"O projeto foi criado todo na linguagem Elixir na versão 1.11.4 utilizando o framwork Phoenix versão 1.5.13. Para fazer as taxas de conversão foi utilizado a API do Exchangeratesapi.io Para a persistência dos dados foi utilizado o PostgreSQL. Outras bibliotecas que foram utilizadas: credo para garantir qualidade sobelow para checar as vulnerabilities do projeto excoveralls manter a cobertura e relatório de testes tesla cliente HTTP para fazer requisições Arquivos licença e changelog como documentação e qualidade de entrega","ref":"readme.html#informacoes-tecnicas","title":"JayaCurrencyConverter - Informacoes Tecnicas","type":"extras"},{"doc":"Execute os seguintes comandos: git clone https://github.com/franknfjr/jaya_currency_converter cd jaya_currency_converter Após entrar no diretório, existe um arquivo .env.sample que é obrigatório inserir o valor da API_KEY para carregar em variáveis de ambiente. Caso você não tenha uma API_KEY, é preciso se registrar no site Altere o arquivo .env.sample para .env Execute o seguinte comando: source .env Feito isso podemos fazer a compilação e excução da aplicação, executando os seguintes comandos: mix deps.get mix ecto.create && mix ecto.migrate","ref":"readme.html#instala%C3%A7%C3%A3o","title":"JayaCurrencyConverter - Instalação","type":"extras"},{"doc":"Para início, vamos observar todas nossas rotas executando o comando: mix phx.routes Metodo endpoint descrição valores que podem ser passados para os parametros GET / exibe o texto #JayaCurrencyConverter GET /api/users lita todos usuarios GET /api/users/:id lista um usuario específico id POST /api/users esse endpoint cria um usuario name GET /api/users/:user_id/transactions lista todas transações de um usuário user_id GET /api/users/:user_id/transactions/:id lista uma transação específica de um usuário user_id , id POST /api/users/:user_id/transactions cria uma transação user_id , amount , currency_from , currency_to ⚠️ Todos os campos id seguem o format de UUID Agora execute o comando para iniciar a aplicação. mix phx.server Abaixo, alguns exemplos de chamadas que serão feitas nessa API: POST /api/users curl --request POST \\ --url http://localhost:4000/api/users \\ --header 'Content-Type: application/json' \\ --data '{ "user": { "name": "Frank" } }' O código HTTP de retorno deve ser 201 e o corpo esperado na resposta é: { "created_at": "2021-12-24T14:46:52", "id": "f4e456d0-78f1-42ba-a3ee-af9440923074", "name": "Frank" } GET /api/users curl --request GET \\ --url http://localhost:4000/api/users \\ --header 'Content-Type: application/json' O código HTTP de retorno deve ser 200 e o corpo esperado na resposta é: [ { "created_at": "2021-12-24T14:44:38", "id": "e4fd3017-33f8-43e7-98ed-2ed388dcfab0", "name": "Frank" } ] POST /api/users/:user_id/transactions curl --request POST \\ --url http://localhost:4000/api/users/0d522e67-3239-4105-a534-df47ac541bf0/transactions \\ --header 'Content-Type: application/json' \\ --data '{ "transaction": { "amount": 12, "currency_from": "BRL", "currency_to": "USD" } }' O código HTTP de retorno deve ser 201 e o corpo esperado na resposta é: { "amount": "12", "amount_to": 2.1142, "created_at": "2021-12-24T14:54:10", "currency_from": "BRL", "currency_to": "USD", "id": "bde63d46-f074-4ad1-bba8-2afdc7c8f746", "rate": "1.13208", "user_id": "0d522e67-3239-4105-a534-df47ac541bf0" } GET /api/users/:user_id/transactions curl --request GET \\ --url http://localhost:4000/api/users/ab0f5215-42ca-45b2-a66d-2f8e44537a29/transactions \\ --header 'Content-Type: application/json' O código HTTP de retorno deve ser 200 e o corpo esperado na resposta é: [ { "amount": "12", "amount_to": null, "created_at": "2021-12-24T14:59:11", "currency_from": "BRL", "currency_to": "USD", "id": "d29fd494-35eb-42d1-b91b-85257ef2af86", "rate": "1.13208", "user_id": "ab0f5215-42ca-45b2-a66d-2f8e44537a29" } ]","ref":"readme.html#funcionamento","title":"JayaCurrencyConverter - Funcionamento","type":"extras"},{"doc":"A aplicação está no Gigalixir no endereço https://jayacurrencyconverter.gigalixirapp.com. Um dos motivos de utilizar o serviçõ é que não tem sleeps da aplicação no plano free.","ref":"readme.html#deploy","title":"JayaCurrencyConverter - Deploy","type":"extras"},{"doc":"Copyright (c) 2021, Frank Ferreira. JayaCurrencyConverter is MIT licensed","ref":"readme.html#licen%C3%A7a","title":"JayaCurrencyConverter - Licença","type":"extras"},{"doc":"All notable changes to this project will be documented in this file.","ref":"changelog.html","title":"Changelog","type":"extras"},{"doc":"Added Added first changelog!","ref":"changelog.html#0-1-0-december-21-2021","title":"Changelog - 0.1.0 (December 21, 2021)","type":"extras"},{"doc":"MIT License Copyright (c) 2021 Frank Ferreira Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","ref":"license.html","title":"LICENSE","type":"extras"}]