Packages

hex_core

0.14.0
0.19.0 0.18.0 0.17.0 0.16.1 0.16.0 0.15.0 0.14.1 0.14.0 0.13.0 0.12.2 0.12.1 retired 0.12.0 0.11.0 0.10.3 0.10.2 0.10.1 0.10.0 0.9.0 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.1 0.5.0 0.4.0 0.3.0 retired 0.2.1 0.2.0 0.1.1 0.1.0

Reference implementation of Hex specifications

HexDocs

Current section

Files

Jump to
Readme
44 Versions
0 Dependencies
Dependants
2 Advisories
Files
Activity
hex_core src hex_api_short_url.erl
Raw

src/hex_api_short_url.erl 

%% @doc

%% Hex HTTP API - Short URLs.

-module(hex_api_short_url).

-export([create/2]).



%% @doc

%% Creates a short URL.

%%

%% Examples:

%%

%% ```

%% > hex_api_short_url:create(hex_core:default_config(), <<"https://hex.pm/packages/example">>).

%% {ok, {201, ..., #{<<"url">> => <<"https://hex.pm/l/XXXXX">>}}}

%% '''

%% @end

-spec create(hex_core:config(), binary()) -> hex_api:response().

create(Config, URL) when is_map(Config) and is_binary(URL) ->

    Body = #{<<"url">> => URL},

    hex_api:post(Config, ["short_url"], Body).