Cada produto tem estes campos. Os opcionais ficam de fora quando estão vazios.
id · string- Id estável, também o fim do endereço da página do produto.
name · string- Nome do produto.
description · string- Descrição numa frase.
audience · string[]- Para quem é: b2b, individual ou ambos.
country · string- País de origem.
website · uri- O site do produto.
longDescription · string- Alguns parágrafos sobre o produto.
features · string[]- Funcionalidades principais.
useCases · string[]- Um a quatro ids de casos de utilização.
category · string- Id de categoria, como em /categories/{id}.
verified · boolean- opcional · true quando o criador verificou que é o dono; caso contrário, não aparece.
logoUrl · uri- opcional · Logótipo (PNG, JPEG ou WebP); não aparece quando não existe.
O mesmo em tipos TypeScript:
export interface Software {
/** Stable id, also the end of the product’s page address. */
id: string;
/** Product name. */
name: string;
/** One-sentence description. */
description: string;
/** Who it’s for: b2b, individual or both. */
audience: ("b2b" | "individual")[];
/** Country of origin. */
country: string;
/** The product’s website. */
website: string;
/** A few paragraphs about the product. */
longDescription: string;
/** Main features. */
features: string[];
/** One to four use-case ids. */
useCases: string[];
/** Category id, as in /categories/{id}. */
category: string;
/** true when the maker verified ownership; absent otherwise. */
verified?: true;
/** Logo (PNG, JPEG or WebP); absent when there is none. */
logoUrl?: string;
}
/** countries.json, GET /api/software/countries */
export type Countries = string[];
/** categories.json, GET /api/categories/counts */
export type CategoryCounts = Record<string, number>;
/** One entry of alternatives.json */
export interface Alternative {
tool: string;
name: string;
page: string;
ids: string[];
}